On this page
connectorGrants
query · in the family Your own session
What it does
List the AI assistants connected to one organization — yours, or every member’s if you own the organization — with each one’s access and expiry.
The AI assistants connected to one organization — the caller's OWN (any member), or EVERY member's when the caller owns the organization (a page of at most 100, nextToken). orgId defaults to the acting organization; another organization must be in the caller's group. Reads only.
What happens
Reads only. The acting organization unless you name another in your group; a page at a time for an owner’s wider list.
Who may call it
Capability area: Your own session — What every signed-in person may do for themselves — their session, their profile and their own work.
- Owner
- System Administrator
- Manager
- Associate Manager
- Warehouse Associate
- Sales Associate
- Cashier
- An API key whose scope allows
api:connectorGrants
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
orgId | ID | no | No further notes. |
limit | Int | no | How many records to answer at most; a page may hold fewer. |
nextToken | String | no | The cursor from the previous page, passed back exactly as received. |
Returns
ConnectorGrantPage ConnectorGrantPage! — One page of connected assistants — the caller's own, or every member's for an owner (at most 100 a page; nextToken for the next).
This is a page: items holds the records and nextToken the cursor for the next page — pass it back verbatim until it is null. See paging.
Example request
query ExampleConnectorGrants($orgId: ID) {
connectorGrants(orgId: $orgId) {
items {
id
clientId
clientName
access
scope
userId
orgId
createdAt
expiresAt
}
nextToken
}
}
Variables:
{
"orgId": "01900000-0000-7000-8000-b0cf4f3c0000"
}
Example response
{
"data": {
"connectorGrants": {
"items": [
{
"id": "01900000-0000-7000-8000-37386ae00000",
"clientId": "<client id>",
"clientName": "Blue jeans",
"access": "<access>",
"scope": "<scope>",
"userId": "01900000-0000-7000-8000-11f967df0000",
"orgId": "01900000-0000-7000-8000-b0cf4f3c0000",
"createdAt": "2027-01-31T00:00:00.000Z",
"expiresAt": "2027-01-31T00:00:00.000Z"
}
],
"nextToken": "<the cursor from the previous page>"
}
},
"extensions": {
"at": {
"callId": "01EXAMPLE-CALL-ID",
"version": {
"requested": null,
"serviced": {
"name": "genesis",
"number": 0
}
}
}
}
}
Errors this call can answer
VALIDATION/INVALID— Something in the request is not valid. (VALIDATION)AUTHN/REQUIRED— Sign in to do this. (AUTHN)AUTHZ/FORBIDDEN— Your role does not allow this action. (AUTHZ)RATE_LIMIT/THROTTLED— Too many requests in a short time. (RATE_LIMIT)NOT_FOUND/*— That record could not be found. (NOT_FOUND)