XExenforo-ltd
Forums

Get information about the specified forum

Changed on

Get information about the specified forum.

get/forums/{id}/

Request

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

OK

Changes

  • e271d0e41f6dRevision changes
    • breaking

      the response's property type changed from string to object for status

    • warning

      deleted the path request parameter id

    • info

      api operation id get_forums_id_ removed and replaced with getForumsId

    • info

      the endpoint scheme security XF-Api-Key was added to the API

    • info

      the endpoint scheme security XF-OAuth2 was added to the API

    • info

      added the new optional header request parameter XF-Api-User to all path's operations

    • info

      added the new optional query request parameter api_bypass_permissions to all path's operations

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • fc0a40f3b859Revision changes
    • breaking

      added the new path request parameter id

    • breaking

      the response's property type changed from object to string for status

    • warning

      the optional response header XF-Latest-Api-Version removed for the status 200

    • warning

      the optional response header XF-Request-User removed for the status 200

    • warning

      the optional response header XF-Request-User-Extras removed for the status 200

    • warning

      the optional response header XF-Used-Api-Version removed for the status 200

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      api operation id getForumsId removed and replaced with get_forums_id_

    • info

      the endpoint scheme security XF-Api-Key was removed from the API

    • info

      the endpoint scheme security XF-OAuth2 was removed from the API