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

# List Workspace Users

> List all members of a workspace with their roles.

## Authentication & Scope

Requires the `workspace-users-read` ability.

## Request

```http theme={null}
GET /workspaces/1/users HTTP/1.1
Host: api.raydocs.com
Authorization: Bearer <token>
```

### Path Parameters

| Parameter     | Type    | Required | Description      |
| ------------- | ------- | -------- | ---------------- |
| `workspaceId` | integer | Yes      | The workspace ID |

## Response

`200 OK` – An array of workspace members.

```json theme={null}
[
  {
    "id": 1,
    "name": "John Doe",
    "email": "john@example.com",
    "role": "admin",
    "photo_url": "https://gravatar.com/..."
  },
  {
    "id": 2,
    "name": "Jane Smith",
    "email": "jane@example.com",
    "role": "user",
    "photo_url": "https://gravatar.com/..."
  }
]
```

### Role Values

| Role       | Description                                            |
| ---------- | ------------------------------------------------------ |
| `admin`    | Full access, can manage workspace settings and users   |
| `user`     | Can create and edit templates, sessions, and documents |
| `readonly` | View-only access to workspace contents                 |


## OpenAPI

````yaml get /workspaces/{workspaceId}/users
openapi: 3.0.1
info:
  title: Raydocs API
  description: REST API for document extraction with AI-powered data parsing
  version: 1.0.0
servers:
  - url: https://api.raydocs.com
security:
  - bearerAuth: []
tags:
  - name: Workspaces
    description: Create and manage workspaces.
  - name: Workspace Users
    description: Manage users within a workspace.
  - name: Extraction Templates
    description: Define extraction schemas and settings.
  - name: Extraction Sessions
    description: Manage extraction jobs and documents.
  - name: Batch Operations
    description: Bulk operations on sessions.
  - name: Documents
    description: Upload and manage source documents.
  - name: Workflows
    description: Discover workflow runs and read their public outputs.
  - name: Results
    description: Access extraction results.
paths:
  /workspaces/{workspaceId}/users:
    get:
      tags:
        - Workspace Users
      summary: List Workspace Users
      description: List all members of a workspace. Requires `workspace-users-read`.
      operationId: listWorkspaceUsers
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WorkspaceUser'
        '403':
          description: Forbidden
components:
  schemas:
    WorkspaceUser:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        email:
          type: string
          format: email
        role:
          type: string
          enum:
            - admin
            - user
            - readonly
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        Personal Access Token created from the Raydocs dashboard.

        Include in the Authorization header: `Bearer <your_token>`

        See [API Keys](/api-reference/api-keys) for token creation and
        management.

````