List roles

⚠️
Preview — this feature is being built; the design below is the spec.
GET https://app.syntic.ai/v1/compliance/roles

Return the roles defined in the organization and what each allows, so an export can show what a person was entitled to do.

For how this fits into a full workflow, see Compliance API.

Headers

HeaderRequiredValue
AuthorizationYesBearer <admin key>: an Admin API key (sk_admin_...) that carries the compliance:read scope (plus compliance:write for deletions and holds). Enterprise plans only. See Compliance API.
syntic-betaYes, while in previewcompliance-2026-12-01. Without it the call fails with 400 beta_required. See Versioning.

Query parameters

ParameterTypeDefaultDescription
limitinteger201 to 100.
after_idstringNext page: the previous page’s last_id.
before_idstringPrevious page: the previous page’s first_id.

Response

200 OK, Content-Type: application/json

{
  "data": [
    {
      "id": "role_01JCT6U8W0Y2A4C6E8G0",
      "type": "role",
      "name": "developer",
      "scope": "organization",
      "permissions": [
        "api_keys:own",
        "workspaces:use",
        "console:read"
      ],
      "member_count": 41
    }
  ],
  "has_more": false,
  "first_id": "role_01JCT6U8W0Y2A4C6E8G0",
  "last_id": "role_01JCT6U8W0Y2A4C6E8G0"
}
FieldTypeDescription
scopestringorganization or workspace.
permissionsarrayPermission strings granted by the role.

Examples

curl -sS "https://app.syntic.ai/v1/compliance/roles" \
  -H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
  -H "syntic-beta: compliance-2026-12-01"

Errors

Errors use the error envelope and carry a request_id. Codes specific to this operation:

StatustypecodeWhen
400invalid_request_errorbeta_requiredThe syntic-beta header is missing.
401authentication_errorinvalid_api_keyThe admin key is missing, unknown, revoked or expired.
403permission_erroradmin_key_requiredAn inference key was used.
403permission_errorscope_missingThe admin key lacks the compliance:read (or, for writes, compliance:write) scope.
429rate_limit_errorrate_limitedToo many requests; wait for Retry-After. See Rate-limit headers.
Was this page helpful?