List roles

GET

/api/v1/org/roles

curl --request GET \
  --url https://api.aletheia-ops.com/api/v1/org/roles \
  --header 'Authorization: Bearer <token>'

• Production
• Local development

Authorizations

• bearerAuth
• sessionCookie

Responses

200

OK

Media typeapplication/json

Roles response

object

items

Array<object>

A full role with its permission keys

object

id

string

key

string

name

string

description

string

is_system

boolean

permissions

Array<string>

Example^generated

{
  "items": [
    {
      "id": "example",
      "key": "example",
      "name": "example",
      "description": "example",
      "is_system": true,
      "permissions": [
        "example"
      ]
    }
  ]
}

401

No valid credential was presented, or it has expired.

Media typeapplication/json

object

code

required

Stable, machine-readable identifier. Branch on this.

string

message

required

Human-readable explanation. Safe to display; do not parse.

string

Examples

{
  "code": "unauthorized",
  "message": "authentication required"
}

{
  "code": "invalid_credentials",
  "message": "invalid email or password"
}

{
  "code": "invalid_token",
  "message": "invalid or expired token"
}

{
  "code": "token_reuse",
  "message": "session revoked"
}

{
  "code": "webhook_unauthorized",
  "message": "webhook verification failed"
}

403

Authenticated, but not permitted to perform this action.

Media typeapplication/json

object

code

required

Stable, machine-readable identifier. Branch on this.

string

message

required

Human-readable explanation. Safe to display; do not parse.

string

Examples

{
  "code": "forbidden",
  "message": "you do not have permission to perform this action"
}

{
  "code": "csrf_failed",
  "message": "missing or invalid CSRF token"
}

{
  "code": "account_deactivated",
  "message": "your account is deactivated; contact your administrator"
}

{
  "code": "ai_disabled",
  "message": "the AI assistant is disabled for this organization"
}

500

An unexpected failure. Diagnostic detail is logged server-side and deliberately not returned. Quote the X-Request-Id response header when reporting one.

Media typeapplication/json

object

code

required

Stable, machine-readable identifier. Branch on this.

string

message

required

Human-readable explanation. Safe to display; do not parse.

string

Examples

Exampleinternal_error

{
  "code": "internal_error",
  "message": "internal server error"
}