Skip to main content
GET
List on-behalf-of grants
The Console’s delegation list: each on-behalf-of grant’s workflow version, the company it acts for, whether it covers the company’s descendants, the connection it is limited to, its status and dates, named in words. targetOrgUnitId narrows the list to one company. Who gave or revoked a grant, and its note, are never returned. Your role grants, narrowed by your credential’s scopes, must hold grants:read at your acting organization and again at the deployment root; otherwise the call is 403 permission_denied naming grants:read, with a recorded decisionId. meta.partial is true when the 500-grant read cap was reached.

Paging

Pass limit for the grants per page (default 15, at most 50; a larger value is 400 too_big) and the previous page’s meta.nextCursor as cursor, with the other parameters unchanged. Grants come oldest first, by grantedAt and then id. meta.hasMore is true exactly when meta.nextCursor is set. Each page is cut from the whole answer your credential may read, so every page applies the same rules; meta.partial reports the 500-grant read cap on every page. A cursor from other parameters or another route is 400 Invalid cursor.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

targetOrgUnitId
string

Only grants that act for this company.

Minimum string length: 1
limit
integer
default:15

Grants per page (default 15). A value above 50 is 400 too_big; anything but a positive integer is 400 Invalid: limit.

Required range: 1 <= x <= 50
cursor
string

The previous page's meta.nextCursor, with the other parameters unchanged; any other value is 400 Invalid cursor.

Minimum string length: 1

Response

On-behalf-of grants

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.