Forums

Get information about the specified forum

Get information about the specified forum.

get/forums/{id}/

Query parameters

with_threadsboolean

If true, gets a page of threads in this forum

pageinteger

prefix_idinteger

Filters to only threads with the specified prefix.

starter_idinteger

Filters to only threads started by the specified user ID.

last_daysinteger

Filters to threads that have had a reply in the last X days.

unreadboolean

Filters to unread threads only. Ignored for guests.

thread_typestring

Filters to threads of the specified thread type.

orderstring

Method of ordering: last_post_date, post_date. When in a specific forum context: title, reply_count, view_count, vote_score, first_post_reaction_score.

directionstring

Either "asc" or "desc" for ascending or descending. Applies only if an order is provided.

Response

Changes

Changed in 2 of the 7 revisions of this API.31013

Mar 18, 2026e271d0e41f6d1110See the full diff
- ▲
  the response's property type changed from string to object for status
  response-property-type-changed
- ●
  deleted the path request parameter id
  request-parameter-removed
- ○
  api operation id get_forums_id_ removed and replaced with getForumsId
  api-operation-id-removed
- ○
  the endpoint scheme security XF-Api-Key was added to the API
  api-security-added
- ○
  the endpoint scheme security XF-OAuth2 was added to the API
  api-security-added
- ○
  added the new optional header request parameter XF-Api-User to all path's operations
  new-optional-request-default-parameter-to-existing-path
- ○
  added the new optional query request parameter api_bypass_permissions to all path's operations
  new-optional-request-default-parameter-to-existing-path
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 3, 2026fc0a40f3b859293See the full diff
- ▲
  added the new path request parameter id
  new-request-path-parameter
- ▲
  the response's property type changed from object to string for status
  response-property-type-changed
- ●
  the optional response header XF-Latest-Api-Version removed for the status 200
  optional-response-header-removed
- ●
  the optional response header XF-Request-User removed for the status 200
  optional-response-header-removed
- ●
  the optional response header XF-Request-User-Extras removed for the status 200
  optional-response-header-removed
- ●
  the optional response header XF-Used-Api-Version removed for the status 200
  optional-response-header-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  api operation id getForumsId removed and replaced with get_forums_id_
  api-operation-id-removed
- ○
  the endpoint scheme security XF-Api-Key was removed from the API
  api-security-removed
- ○
  the endpoint scheme security XF-OAuth2 was removed from the API
  api-security-removed
This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history