Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
page
object

JSON:API pagination, as page[limit] and page[offset]. The same as the top-level limit and offset parameters; when both forms are sent, page[...] wins.

filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • document_id: Filter reviewers to those eligible to review or approve the specified document: members of the organisation owning the document, plus members of organisations on a currently-active share of the document's scheme. Preferred, and takes precedence over scheme_id — the organisation owning a document is not always the one owning its scheme, because a partner can upload onto a shared scheme. The same set the API enforces when an approval request names approvers, so anyone offered here will be accepted as an approver on a write. Not for notification nominations: notify takes job roles, listed via the document_id filter on /v3/job-roles.
  • scheme_id: Filter reviewers to members of organisations on a currently-active share of the specified scheme that the caller can see, plus members of the organisation owning the scheme when the caller belongs to it. A share that has ended, or has not yet started, contributes no one. This assumes the scheme's owner owns the document, and then the list never offers anyone the API would refuse as an approver. When a partner uploaded the document, the list can leave out people the API would accept. Once that partner's share has ended, it also offers members of the scheme's owner, whom the API refuses. document_id is the exact filter. Ignored when document_id is given. If neither is supplied, an empty list is returned.
  • org_id: Filter reviewers to members of a specific organisation (own org or a partner org connected via the scheme).
  • name: Filter by name(s) - filters by first and last name (case insensitive)
  • id_not_in: Exclude users whose ID is in the provided list.

For more information on using named filters, see the docs

Response

A list of users eligible to review documents for this organisation.

JSON API response object

data
A list of reviewers · object[]
required
meta
object
required
jsonapi
object
required