POST/pages/permissions

List explicit permissions on a page

Lists explicit permissions assigned to a page, with optional administrative visibility and text filtering. Use pageId to identify the page, and cursor or beforeCursor to navigate result pages; limit defaults to 20 and cannot exceed 100.

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

6 body fields

Page identifier and optional filters and pagination controls for listing explicit permissions.

pageIdstringrequired
Page identifier (UUID or slug ID).
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 paginated page permissions in the response data.
dataobjectoptional
statusintegeroptional
successbooleanoptional
403Returned when access to the page permissions list is forbidden.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
404Returned when the page is not found.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 403 is returned when access to the permissions list is forbidden. A 404 is returned when the page is not found. The pageId field must identify an existing page, and limit must be between 1 and 100.