List a tenant's roles.
const url = 'https://shiftagent.example.com/tenants/example/roles?limit=20';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://shiftagent.example.com/tenants/example/roles?limit=20' \ --header 'Authorization: Bearer <token>'Lists roles in the tenant. ?name= is an exact-match filter — the recovery path after a 409 name-conflict when the conflicting ID was lost.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Internal tenant ID.
Query Parameters
Section titled “Query Parameters ”Page size (1–100).
Cursor: return items after this object ID (forward pagination). Use the id of the last item of the previous page.
Cursor: return items before this object ID (backward pagination). Mutually exclusive with starting_after.
Exact-match filter on the tenant-unique role name.
Responses
Section titled “ Responses ”A page of roles.
object
Envelope discriminator.
The page of items.
Whether more items exist beyond this page.
Opaque cursor for the next page (pass as starting_after). Null when has_more is false.
Tenant-scoped access profile: optional repository override + skill narrowing. Effective repository = repository_id ?? tenant default; effective skills = effective repository’s skills ∩ skill_access.
object
Unique per tenant — load-bearing for replay-safe provisioning (deterministic 409 + conflicting_resource_id recovery).
Human-readable purpose.
Repository override; null falls through to the tenant default repository.
Grant every skill of the role’s effective repository.
object
Access-mode discriminator.
Grant only the listed skills of the role’s effective repository.
object
Access-mode discriminator.
Skills to grant — each must belong to the role’s effective repository (422 validation-error otherwise).
RFC 3339 / ISO 8601 timestamp, UTC.
RFC 3339 / ISO 8601 timestamp, UTC.
Example
{ "object": "list", "data": [ { "object": "role", "skill_access": { "mode": "all" } } ]}Bad request — malformed body/parameters or an invalid parameter combination (e.g. neither or both of user_id/tenant_id on listConversations, or both pagination cursors).
RFC 9457 problem+json error envelope. type is a URI under https://shiftagent.example.com/problems/{slug} (deployment host substituted); see the API-level problem registry for every slug.
object
Problem type URI (registry slug).
Short, human-readable summary of the problem type.
HTTP status code.
Human-readable explanation specific to this occurrence.
URI reference identifying this occurrence.
Correlation ID for support and log lookup.
On name-conflict, external-id-conflict, and resource-in-use: the ID of the existing/depended-on resource — fetch it and continue (replay recovery).
On validation-error, field-level details.
object
JSON pointer to the offending field.
What failed.
Examples
Invalid parameter combination
{ "type": "https://shiftagent.example.com/problems/validation-error", "title": "Invalid request", "status": 400, "detail": "Exactly one of user_id or tenant_id is required.", "request_id": "req_01hzx8bad001"}Missing or invalid credentials — no bearer token, an unknown/revoked sk_int_ key, or an expired platform JWT.
RFC 9457 problem+json error envelope. type is a URI under https://shiftagent.example.com/problems/{slug} (deployment host substituted); see the API-level problem registry for every slug.
object
Problem type URI (registry slug).
Short, human-readable summary of the problem type.
HTTP status code.
Human-readable explanation specific to this occurrence.
URI reference identifying this occurrence.
Correlation ID for support and log lookup.
On name-conflict, external-id-conflict, and resource-in-use: the ID of the existing/depended-on resource — fetch it and continue (replay recovery).
On validation-error, field-level details.
object
JSON pointer to the offending field.
What failed.
Examples
Missing or invalid bearer token
{ "type": "https://shiftagent.example.com/problems/insufficient-scope", "title": "Unauthorized", "status": 401, "detail": "Provide a valid sk_int_ service key or platform JWT.", "request_id": "req_01hzx8auth001"}Not found — the resource does not exist, was deprovisioned, or lies outside the integration key’s subtree (indistinguishable by design).
RFC 9457 problem+json error envelope. type is a URI under https://shiftagent.example.com/problems/{slug} (deployment host substituted); see the API-level problem registry for every slug.
object
Problem type URI (registry slug).
Short, human-readable summary of the problem type.
HTTP status code.
Human-readable explanation specific to this occurrence.
URI reference identifying this occurrence.
Correlation ID for support and log lookup.
On name-conflict, external-id-conflict, and resource-in-use: the ID of the existing/depended-on resource — fetch it and continue (replay recovery).
On validation-error, field-level details.
object
JSON pointer to the offending field.
What failed.
Examples
Unknown resource
{ "type": "https://shiftagent.example.com/problems/not-found", "title": "Not found", "status": 404, "detail": "No tenant with external_id acme:tenant:999999.", "request_id": "req_01hzx8nf001"}