<!--
  immut documentation, machine-readable.

  Everything in one file:  https://www.immut.io/llms-full.txt
    What immut is, which integration path to choose, authentication and scopes, and the COMPLETE
    API reference: every endpoint with parameters, responses and a runnable curl. Fetch this first
    if you intend to call the API.

  Index of all pages:      https://www.immut.io/llms.txt
  OpenAPI contract:        https://www.immut.io/docs/openapi.json
  This page as HTML:       https://www.immut.io/docs/api/other/get-users

  Any page on this site is available as raw markdown by appending .md to its URL.
-->


# List the people in the organisation

`GET /users`

**Required scope:** `users:read`

Use it to attribute a document to a real person, or to name reviewers in a report. Requires the users:read scope, which is NOT granted to agent keys by default: an admin adds it deliberately, because an agent that protects files does not need to know the staff list. Returns 403 INSUFFICIENT_SCOPE without it.

## Responses

| Status | Meaning |
|---|---|
| `200` | Success Returns: per row: name, email, role, suspended, createdAt, lastLogin, plus meta {page, limit, total, totalPages}. Members of YOUR organisation only. Pending invitations are merged in, so a row may exist for someone who has not accepted yet. |
| `400` | BadRequest |
| `401` | Unauthorized |
| `403` | Forbidden |
| `429` | RateLimited |

## Example

```bash
curl -X GET "https://backend.immut.io/api/v1/users" \
  -H "Authorization: Bearer $IMMUT_API_KEY"
```

## OpenAPI fragment

```json
{
  "/users": {
    "get": {
      "operationId": "getusers",
      "summary": "List the people in the organisation. Use it to attribute a document to a real person, or to name reviewers in a report. Requires the users:read scope, which is NOT granted to agent keys by default: an admin adds it deliberately, because an agent that protects files does not need to know the staff list. Returns 403 INSUFFICIENT_SCOPE without it.",
      "description": "List the people in the organisation. Use it to attribute a document to a real person, or to name reviewers in a report. Requires the users:read scope, which is NOT granted to agent keys by default: an admin adds it deliberately, because an agent that protects files does not need to know the staff list. Returns 403 INSUFFICIENT_SCOPE without it.",
      "responses": {
        "200": {
          "description": "Success Returns: per row: name, email, role, suspended, createdAt, lastLogin, plus meta {page, limit, total, totalPages}. Members of YOUR organisation only. Pending invitations are merged in, so a row may exist for someone who has not accepted yet."
        },
        "400": {
          "$ref": "#/components/responses/BadRequest"
        },
        "401": {
          "$ref": "#/components/responses/Unauthorized"
        },
        "403": {
          "$ref": "#/components/responses/Forbidden"
        },
        "429": {
          "$ref": "#/components/responses/RateLimited"
        }
      },
      "x-required-scope": "users:read"
    }
  }
}
```