API reference Pages
Find a page by slug or hash
get/v1/wikis/{wiki_id}/pages/lookup
Returns the page in a wiki with the given slug or hash, with its content. Useful when you have a page URL rather than its ID. Give exactly one of the two.
Path parameters
| Parameter | Description |
|---|---|
wiki_idstring (uuid)required | The wiki ID. |
Query parameters
| Parameter | Description |
|---|---|
slugstringoptional | The page slug. 1 to 1024 characters. |
hashstringoptional | The page hash (12 characters). 12 to 12 characters. |
Responses
- 200
The page.
Fields of the 200 response of Find a page by slug or hash Field Description objectstringAlways
"page".idstring (uuid)The page ID.
wiki_idstring (uuid)The wiki the page belongs to.
titlestringslugstringThe page part of its SlimWiki URL.
hashstring | nulloptionalA short identifier that stays the same when the page is renamed. It is the last part of the page URL.
archivedbooleancreated_atstring (date-time) | nulloptionalWhen the page was created.
updated_atstring (date-time) | nulloptionalWhen the page was last edited.
contentContentNode[]The page body as a list of content nodes. See the content format guide.
- 400
Neither or both of
slugandhashwere given. Error code:invalid_request.Error body fields
Fields of the 400 error body of Find a page by slug or hash 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 Find a page by slug or hash 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 Find a page by slug or hash 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 Find a page by slug or hash 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.
The ContentNode object
One block or inline node of page content, for example a paragraph, heading or text run.
| Field | Description |
|---|---|
typestringrequired | The node type, such as |
attrsobjectoptional | Type-specific attributes, such as a heading |
contentContentNode[]optional | Child nodes. |
textstringoptional | The text of a |
marksobject[]optional | Inline formatting on a |
The content format guide shows the common node types with examples.