# List users

Source: https://business-api-docs.youhodler.com/docs/api/reference/users/users-list

Returns a paginated list of human actors (users) within the given perimeter.

**`scope_ref` — where to find it**

Decode your bearer token (JWT). The `b2b2x:tenant_ref` claim contains the
topology reference to use as `scope_ref`:

```json
{
  "b2b2x:tenant_ref": "enterprises/c78778b9-b517-4c7b-8393-9db034ab5708"
}
```

Pass this value verbatim as the `scope_ref` query parameter. The format is
`enterprises/<uuid>` for enterprise-scoped callers or `clients/<uuid>` for
client-scoped callers.

## Request

**Request URL — GET**
```http
GET /users
```

## Responses

**200 Operation succeeded**

Operation succeeded.

```json
{
  "items": [
    {
      "created_at": "2026-05-01T10:00:00Z",
      "display_name": "Jane Doe",
      "email": "jane.doe@acme.example",
      "etag": "W/\"a1b2c3d4\"",
      "federation": null,
      "id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
      "identity_source": "platform-managed",
      "resource": "human_actor",
      "scope_ref": "enterprises/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
      "status": "active",
      "updated_at": "2026-05-01T10:00:00Z"
    }
  ],
  "next_page_token": null
}
```

**400 Invalid request payload**

Invalid request payload, query, or parameter shape.

```json
{
  "code": "invalid_request",
  "message": "The request is invalid."
}
```

**401 Caller is not authenticated or the bearer token is invalid**

Caller is not authenticated or the bearer token is invalid.

```json
{
  "code": "unauthorized",
  "message": "Authentication required."
}
```

**403 Caller lacks the required capability or permitted scope**

Caller lacks the required capability or permitted scope.

```json
{
  "code": "forbidden_capability_scope",
  "details": {
    "reason": "missing_capability"
  },
  "message": "The caller lacks the required capability for this scope"
}
```

**429 Request rate limit exceeded**

Request rate limit exceeded. Retry after the delay indicated in the `details.retry_after_ms` field.

```json
{
  "code": "rate_limited",
  "details": {
    "retry_after_ms": 5000
  },
  "message": "Too many requests."
}
```

**502 Upstream service returned an unexpected error**

Upstream service returned an unexpected error.

```json
{
  "code": "upstream_error",
  "message": "An upstream service returned an unexpected error."
}
```

**503 Service is temporarily unavailable**

Service is temporarily unavailable; retry with backoff.

```json
{
  "code": "temporarily_unavailable",
  "details": {
    "reason": "federation_discovery_failed"
  },
  "message": "A downstream service is temporarily unavailable"
}
```

**Related endpoints:**

- `POST` [Create user](/docs/api/reference/users/users-create) — Create a new user
- `GET` [Get user](/docs/api/reference/users/users-get) — Fetch a single user by ID