List partner standing grant rows
Platform module
GET/partner-standing-grantspartnerStandingGrants.list
A standing grant of the partner and client agreement (1354, Section 4.6.1): the client Owner lets the partner's staff read one area of the client org until an expiry within a year, citing the clause. Each issues an org-level record grant; either side may end it early. Partner staff never write through one. Returns a cursor page of partner standing grant rows the caller may see. The default order is `valid_from` descending, newest first. Supports sparse fieldsets and the filter grammar.
- Requires the capability org.settings.read.
- OAuth scopes: org.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Response 200: a page of PartnerStandingGrant
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the partner standing grant. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row. |
| partner_org_id | string (uuid) | Yes | Identifier of the partner org whose staff may read. |
| capability_code | string | Yes | The scope: one read capability a support session may grant.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| agreement_reference | string | Yes | The clause of the agreement that provides the grant.Constraints: length 1 to 300 |
| valid_from | string (date-time) | Yes | When access began. |
| valid_to | string (date-time) | Yes | When access ends on its own. |
| record_grant_id | string (uuid) | Yes | Identifier of the org-level record grant the standing grant issued. |
| ended_at | string (date-time) | null | Yes | When someone ended the grant early. |
| ended_by | string (uuid) | null | Yes | Identifier of the person who ended it early. |
{
"data": [
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"partner_org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"capability_code": "org.settings.read",
"agreement_reference": "Partner agreement, clause 7.2",
"valid_from": "2026-10-08T14:30:00Z",
"valid_to": "2026-10-08T14:30:00Z",
"record_grant_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"ended_at": "2026-10-08T14:30:00Z",
"ended_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/partner-standing-grants" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.partnerStandingGrants.listAll()) {
console.log(row);
}for row in xos.partner_standing_grants.list_all():
print(row)xos partner-standing-grants list --all