> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vertracloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# List Roles

> Lists a workspace's roles. Requires the `members:read` permission.

Requires `members:read` (not a separate `roles:read` — reading the role list is bundled with
reading members). An API key needs the `workspaces:read` scope.

### Path

<ParamField path="id" type="string" required>Workspace ID.</ParamField>

### Response

<ResponseField name="response" type="APIWorkspaceRole[]">
  <Expandable title="Toggle object">
    <ResponseField name="id" type="string" />

    <ResponseField name="workspace_id" type="string" />

    <ResponseField name="name" type="string" />

    <ResponseField name="permissions" type="WorkspacePermission[]">See the [permission catalog](/knowledge-base#10-workspaces) — 19 entries across apps, databases, snapshots, members, roles and activities.</ResponseField>
    <ResponseField name="preset" type="'admin' | 'developer' | 'operator' | 'viewer' | null">Seed role this was created from. `null` for a hand-made role. Purely informational — a seed role is editable and deletable like any other.</ResponseField>
    <ResponseField name="position" type="number">Display order.</ResponseField>

    <ResponseField name="members_count" type="number" />

    <ResponseField name="created_at" type="string" format="date-time" />

    <ResponseField name="updated_at" type="string" format="date-time" />
  </Expandable>
</ResponseField>

### Errors

| Status | Code                          | When                                            |
| ------ | ----------------------------- | ----------------------------------------------- |
| 403    | `WORKSPACE_PERMISSION_DENIED` | Caller lacks `members:read`.                    |
| 404    | `WORKSPACE_NOT_FOUND`         | Workspace doesn't exist or you're not a member. |