REST API Documentation
/forums/forums
Get list of forums
For requests using an OAuth Access Token for a particular member, only forums the authorized user can view will be included
Parameters
| Name | Type | Description |
|---|---|---|
clubs
|
int | 0|1 Include club forums, default: 1 |
page
|
int | Page number |
perPage
|
int | Number of results per page - defaults to 25 |
Exceptions
This endpoint doesn't throw any exceptions.
Response
| Name | Type | Description |
|---|---|---|
page
|
int | The page number for the results being shown |
perPage
|
int | The number of results that will be on each page |
totalResults
|
int | The total number of results |
totalPages
|
int | The number of pages of results |
results
|
array of forum objects | The results for this page |
forum object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
name
|
string | Forum name |
path
|
string | Forum name including parents (e.g. "Example Category > Example Forum") |
type
|
string | The type of forum: "discussions", "questions", "category", or "redirect" |
topics
|
int | Number of topics in forum |
url
|
string | URL |
parentId
|
int|null | Parent Node ID |
permissions
|
object|null | Node permissions |