Docmost Octri Preview
POST/pages/backlinks

List pages linking to or from a page

Lists pages that link to or from a specified page. Set direction to incoming or outgoing, and use the cursors to retrieve additional pages of results.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

7 body fields

Filters and pagination options for listing pages linked to the specified page.

directionstringrequired
`incoming` lists pages linking to this page; `outgoing` lists pages it links to.
Allowed:incomingoutgoing
pageIdstringrequired
Page identifier.
adminViewbooleanoptional
If `true`, the list includes all items the admin has global permissions to access by virtue of their admin role.
beforeCursorstringoptional
Set to `prevCursor` from the previous call to list the previous page. Ignored when `cursor` is also supplied.
cursorstringoptional
Set cursor to `nextCursor` returned by the previous call to list items in the next page.
limitintegeroptional
Maximum number of items to return per page.
Default:20
querystringoptional
Optional text filter to search within the listed items (e.g. filter members by name).

3 status codes
200Returns a paginated collection of linked pages.
dataobjectoptional
statusintegeroptional
successbooleanoptional
403Returned when the authenticated user is forbidden from accessing the requested links.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
404Returned when the specified page does not exist.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 403 is returned when the authenticated user is not permitted to access the requested links. A 404 is returned when the page identified by pageId does not exist. pageId and direction are required, and direction must be incoming or outgoing; limit must be between 1 and 100 and defaults to 20 when omitted.