Skip to content

List reviewers registered for the caller's tenant

GET
/v1/approvals/reviewers
curl --request GET \
--url 'https://example.com/v1/approvals/reviewers?limit=25&role=standard' \
--header 'Authorization: Bearer <token>'

Cursor-paginated. Optional ?role= narrows to a specific role class. Reviewer-role gate does NOT apply — roster management is an admin surface, not a reviewer-only action.

limit
integer
default: 25 >= 1 <= 100

1..100. Default 25.

cursor
string

Opaque cursor from a prior response. Absent → first page.

role

Reviewer role class. Hierarchy: standard < senior < admin.

string
Allowed values: standard senior admin

Filter reviewers by role class.

Page of reviewers.

Media typeapplication/json
object
data
required
Array<object>

Reviewer roster row. Deactivation is soft (audit trail survives offboarding). deactivatedAt present → reviewer no longer receives approvals.

object
id
required

ReviewerId.

string format: uuid
tenantId
required
string format: uuid
userId
required
string format: uuid
role
required

Reviewer role class. Hierarchy: standard < senior < admin.

string
Allowed values: standard senior admin
displayName
string
createdAt
required
string format: date-time
deactivatedAt
string format: date-time
nextCursor

Opaque cursor for the next page. Absent when hasMore: false.

string
hasMore
required
boolean
Example
{
"data": [
{
"role": "standard"
}
]
}

Malformed query parameter.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": {},
"requestId": "example"
}
}

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": {},
"requestId": "example"
}
}