Alerts5

Attachments8

Auth3

Conversations15

Featured content1

Forums3

Index1

Me6

Media10

Media albums8

Media categories7

Media comments6

Nodes6

OAuth24

oEmbed1

Posts7

Profile posts11

Resource categories7

Resource reviews6

Resource updates4

Resource versions4

Resources10

Search4

Search forums2

Stats1

Threads12

Users10

Search

Retrieve search results for a given search

Changed on Mar 18, 2026

Retrieve search results for a given search.

get/search/{id}/

Request

Base URL
https://example.com/api
Auth
- OAuth 2
  Authorization codehttps://example.com/oauth2/authorize
  Token URLhttps://example.com/api/oauth2/token
  Scopessearch:read
- or API key in header XF-Api-Key
TypeScript
https://skmtc.dev/xenforo-ltd/apis/xenforo-api/docs/search/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

pageinteger

Response

OK

get_older_results_dateinteger nullable

Changes

Mar 18, 2026e271d0e41f6d Revision 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_search_id_ removed and replaced with getSearchId
- 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
Feb 3, 2026fc0a40f3b859 Revision 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 getSearchId removed and replaced with get_search_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

Operation history