Search forums

Get information about the specified search forum

Get information about the specified search forum.

get/search-forums/{id}/

Query parameters

with_threadsboolean

If true, gets a page of threads in this search forum

pageinteger

Response

OK

Changes

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

  • e271d0e41f6d1210See 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

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ○

      api operation id get_search_forums_id_ removed and replaced with getSearchForumsId

      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

  • fc0a40f3b859294See 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 getSearchForumsId removed and replaced with get_search_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

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog