# List workspace members

List the existing members and roles in a workspace.

## Endpoint

`GET /api/v1/workspaces/{workspace_id}/members`

## Authentication

| Class | Authentication | Minimum role | API key |
| --- | --- | --- | --- |
| dashboard-session-api | Dashboard session cookie; mutations also require X-CX-Request: 1. | member | Not allowed |

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `workspace_id` | path | `string` | Yes | — |

## Request body

This operation has no request body.

## Example

```bash
curl --request GET 'https://operade.ai/api/v1/workspaces/ws_demo/members' \
  --cookie 'cx_session=YOUR_SESSION_COOKIE'
```

## Responses

| Status | Description | Content |
| --- | --- | --- |
| 4XX | Handled client error | application/json: `ErrorResponse` |
| 200 | Successful Response | application/json: `WorkspaceMemberListResponse` |

### 4XX application/json response schema

| Field path | Type | Reference | Format | Nullable | Required | Enum | Description |
| --- | --- | --- | --- | --- | --- | --- | --- |
| `$` | `object` | ErrorResponse | — | No | Yes | — | — |
| `error` | `object` | ErrorItem | — | No | Yes | — | — |
| `error.code` | `string` | — | — | No | Yes | — | — |
| `error.details` | `object` | — | — | No | No | — | — |
| `error.message` | `string` | — | — | No | Yes | — | — |

### 200 application/json response schema

| Field path | Type | Reference | Format | Nullable | Required | Enum | Description |
| --- | --- | --- | --- | --- | --- | --- | --- |
| `$` | `object` | WorkspaceMemberListResponse | — | No | Yes | — | — |
| `items` | `array<WorkspaceMember>` | — | — | No | Yes | — | — |
| `items[]` | `object` | WorkspaceMember | — | No | Yes | — | — |
| `items[].email` | `string` | — | — | No | Yes | — | — |
| `items[].membership_id` | `string` | — | — | No | Yes | — | — |
| `items[].name` | `string` | — | — | No | Yes | — | — |
| `items[].role` | `string` | — | — | No | Yes | "owner", "admin", "member" | — |
| `items[].user_id` | `string` | — | — | No | Yes | — | — |

### Response example

```json
{
  "items": []
}
```

## Errors

Reviewed common and route-declared errors are summarized here; the list is not exhaustive. Start with the [distributed error index](/docs/reference/api/errors) to find each code's canonical domain page.

| Status | Code | Description |
| --- | --- | --- |
| 401 | `unauthenticated` | Authentication is missing, invalid, or revoked. |
| 403 | `forbidden` | The authenticated caller does not have access to this operation. |
| 404 | `not_found` | The requested workspace resource was not found. |

## Related operations

- [Remove a workspace member](/docs/api-reference/members/remove-workspace-member) — `DELETE /api/v1/workspaces/{workspace_id}/members/{user_id}`
- [Update a workspace member role](/docs/api-reference/members/update-workspace-member-role) — `PATCH /api/v1/workspaces/{workspace_id}/members/{user_id}`
