Skip to main content
GET
List the partner's grants

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Request a token from the token endpoint of the identity provider's domain (https://{cognito-domain}/oauth2/token, with HTTP Basic client authentication) and send it as a Bearer token. Production uses auth.mypilotindex.com. The sandbox uses the dev environment's Cognito domain, which is given to the partner with its sandbox credential. A token carries only the scopes the partner was approved for.

Query Parameters

status
enum<string>

active (live) or revoked; absent lists both.

Available options:
active,
revoked
changed_since
string<date-time>

An RFC 3339 timestamp; only grants granted or revoked at or after it.

limit
integer
default:100
Required range: 1 <= x <= 500
cursor
string

The next_cursor of the previous page, as it came; opaque.

Response

One page of grants.

items
object[]
required
next_cursor
string | null
required

Continues the list after the last item; null on the last page.