# List roles

`GET https://evohub.io/api/v1/roles`

Part of the [Organization API](https://docs-dev.evohub.io/organization.md) reference · operationId `listRoles`.

The default roles (Admin, Member, Viewer) and the organization's custom roles.

**Permission (API-key scope):** `identity:role:read`.

## Authorization

Any one of:

- `bearerAuth` (identity:role:read)
- `apiKeyHeader` (identity:role:read)

Where:

- `bearerAuth`: HTTP Bearer — An EvoHub API key (`evohub_…`) as a bearer token.
- `apiKeyHeader`: API key in the header `X-API-Key` — An EvoHub API key (`evohub_…`).

## Responses

### 200 — The roles.

Content type: `application/json`

Type: `object`

- `data` (array of Role, required)
  - `id` (string, required)
  - `org_id` (string, required)
  - `name` (string, required)
  - `description` (string)
  - `permissions` (array of string, required): Permission names from the catalog (`GET /api/v1/permissions`).
  - `built_in` (string, one of `admin`, `member`, `viewer`): Set on the three default roles, which cannot be deleted and only an administrator edits.
  - `created_at` (string (date-time), required)
  - `updated_at` (string (date-time), required)
- `success` (boolean, required, value `true`)

### 401 — No API key was sent, or it is unknown, revoked or expired (`UNAUTHORIZED`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): The response's `X-Request-ID`; quote it to support.

### 403 — The key lacks the scope this endpoint needs (`FORBIDDEN`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): The response's `X-Request-ID`; quote it to support.

### 429 — Too many requests (`RATE_LIMITED`). Wait `Retry-After` seconds.

Headers:

- `Retry-After` (integer): Seconds to wait.

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): The response's `X-Request-ID`; quote it to support.

### 500 — Something went wrong on EvoHub's side (`INTERNAL_ERROR`). Retry later.

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): The response's `X-Request-ID`; quote it to support.

## Example request

```bash
curl -X GET 'https://evohub.io/api/v1/roles' \
  -H 'Authorization: Bearer <TOKEN>'
```