List OAuth Grants
Lists the authenticated user's own OAuth grants — one per app they have authorized, per account they authorized it for. The list is always the caller's own; there is no parameter for reading another user's grants. Requires a user session: an API key or an OAuth token is refused, so an app can never enumerate the other apps a user has authorized.
Query parameters
Only return grants for this app, prefixed app_. An app the user has never authorized returns an empty list.
The number of grants to return (default 20, max 100).
A cursor; returns grants after this position.
The number of grants to return from the end of the range.
A cursor; returns grants before this position.
The field to sort grants by.
Sort direction.
Response
oauth grants listed
Example response
{
"data": [
{
"account_id": "biz_xxxxxxxxxxxxxx",
"app_id": "app_xxxxxxxxxxxxxx",
"authorized_at": "2026-01-01T12:00:00.000Z",
"created_at": "2026-01-01T12:00:00.000Z",
"id": "oag_xxxxxxxxxxxxxx",
"redirect_url": "https://Booking.Shinetime.example:8443/oauth/Callback/",
"revoked_at": "2026-01-01T12:00:00.000Z",
"scopes": [
"email"
]
}
],
"page_info": {
"end_cursor": "WyJjdXJzb3IiLDFd",
"start_cursor": "WyJjdXJzb3IiLDFd"
}
}Changes
Changed in 3 of the 43 revisions of this API.5
- ○
added the optional property
error/codeto the response with the400statusresponse-optional-property-added
- ○
added the optional property
error/codeto the response with the401statusresponse-optional-property-added
- ○
added the optional property
error/codeto the response with the403statusresponse-optional-property-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
added the optional property
data/items/redirect_urlto the response with the200statusresponse-optional-property-added
This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
endpoint added
endpoint-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
Of the 43 revisions, 1 has no diff computed.