API reference Pages
Search pages in a wiki
get/v1/wikis/{wiki_id}/pages/search
Full-text search over page titles and content, best match first.
Path parameters
| Parameter | Description |
|---|---|
wiki_idstring (uuid)required | The wiki ID. |
Query parameters
| Parameter | Description |
|---|---|
querystringrequired | The text to search for. 1 to 200 characters. |
pageintegeroptional | Page number, starting at 1. Default |
page_sizeintegeroptional | Items per page. Default |
archivedbooleanoptional | Set to Default |
Responses
- 200
A page of results.
Fields of the 200 response of Search pages in a wiki Field Description objectstringAlways
"list".dataobject[]data[].objectstringAlways
"page".data[].idstring (uuid)The page ID.
data[].wiki_idstring (uuid)The wiki the page belongs to.
data[].titlestringdata[].slugstringThe page part of its SlimWiki URL.
data[].hashstring | nulloptionalA short identifier that stays the same when the page is renamed. It is the last part of the page URL.
data[].archivedbooleandata[].updated_atstring (date-time) | nulloptionalWhen the page was last edited.
has_morebooleanWhether another page of results exists after this one.
pageintegeroptionalThe page number returned.
page_sizeintegeroptionalThe page size used.
totalintegeroptionalTotal number of matching items.
- 400
A query parameter is missing or not valid. Error code:
invalid_request.Error body fields
Fields of the 400 error body of Search pages in a wiki Field Description errorobjecterror.codestringA stable, machine-readable error code.
One of
invalid_request,unauthorized,insufficient_scope,forbidden,not_found,conflict,rate_limited,internal_error.error.messagestringA description for people. The wording may change.
error.detailsobject[]optionalFor
invalid_request: the fields that failed validation.error.details[].fieldstringoptionalerror.details[].messagestringoptionalerror.request_idstring | nulloptionalQuote this when contacting support.
- 401
The API key is missing, invalid, revoked or expired. Error code:
unauthorized.Error body fields
Fields of the 401 error body of Search pages in a wiki Field Description errorobjecterror.codestringA stable, machine-readable error code.
One of
invalid_request,unauthorized,insufficient_scope,forbidden,not_found,conflict,rate_limited,internal_error.error.messagestringA description for people. The wording may change.
error.detailsobject[]optionalFor
invalid_request: the fields that failed validation.error.details[].fieldstringoptionalerror.details[].messagestringoptionalerror.request_idstring | nulloptionalQuote this when contacting support.
- 404
The resource does not exist, or this API key cannot see it. Error code:
not_found.Error body fields
Fields of the 404 error body of Search pages in a wiki Field Description errorobjecterror.codestringA stable, machine-readable error code.
One of
invalid_request,unauthorized,insufficient_scope,forbidden,not_found,conflict,rate_limited,internal_error.error.messagestringA description for people. The wording may change.
error.detailsobject[]optionalFor
invalid_request: the fields that failed validation.error.details[].fieldstringoptionalerror.details[].messagestringoptionalerror.request_idstring | nulloptionalQuote this when contacting support.
- 429
Rate limit exceeded. See the
Retry-Afterheader. Error code:rate_limited.Error body fields
Fields of the 429 error body of Search pages in a wiki Field Description errorobjecterror.codestringA stable, machine-readable error code.
One of
invalid_request,unauthorized,insufficient_scope,forbidden,not_found,conflict,rate_limited,internal_error.error.messagestringA description for people. The wording may change.
error.detailsobject[]optionalFor
invalid_request: the fields that failed validation.error.details[].fieldstringoptionalerror.details[].messagestringoptionalerror.request_idstring | nulloptionalQuote this when contacting support.
Any request can also fail with 500 internal_error. See Errors for every code.