---
title: "List User Profiles"
method: GET
path: "/v1/user_profiles?beta=true"
---

# List User Profiles

`GET /v1/user_profiles?beta=true`

## Query parameters

- `limit` integer
- `page` string
- `order` 'asc' | 'desc' — ListOrder enum
- `order_by` 'created_at' | 'name' — Sort field for listing user profiles: `created_at` (default) or `name` (case-insensitive; profiles without a name sort last).

## Headers

- `x-api-key` string
- `anthropic-version` string
- `anthropic-beta` string

## Response `200`

Successful response (OK)

- BetaListUserProfilesResponse
  - `data` BetaUserProfile[], required — User profiles on this page.
    - `id` string, required — Unique identifier for this user profile, prefixed `uprof_`.
    - `type` 'user_profile', required — Object type. Always `user_profile`.
    - `external_id` string, nullable — Platform's own identifier for this user. Not enforced unique.
    - `name` string, nullable — Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name.
    - `access_type` 'application' | 'passthrough' — How the platform uses the API on behalf of the entity this profile represents. `application`: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. `passthrough`: the platform resells raw inference, and the profile identifies the resold-to company.
    - `external_user_onboarded_at` string, date-time, nullable — A timestamp in RFC 3339 format
    - `trust_grants` object, required — Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.
    - `created_at` string, date-time, required — A timestamp in RFC 3339 format
    - `metadata` object, required — Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
    - `updated_at` string, date-time, required — A timestamp in RFC 3339 format
  - `next_page` string, nullable, required — Cursor for the next page, or `null` when there are no more results.

## Other responses

- `400` — Invalid argument - The client specified an invalid argument
- `401` — Unauthenticated - The request does not have valid authentication credentials
- `403` — Permission denied - The caller does not have permission to execute the specified operation
- `404` — Not found - Some requested entity was not found
- `408` — Deadline exceeded - The deadline expired before the operation could complete
- `409` — Aborted - The operation was aborted due to concurrency issue
- `412` — Failed precondition - Operation was rejected because the system is not in required state
- `413` — Out of range - Operation was attempted past the valid range
- `429` — Resource exhausted - Some resource has been exhausted (rate limiting)
- `431` — Request header fields too large - Request metadata was too large
- `499` — Cancelled - The operation was cancelled by the client
- `500` — Internal - Internal server error
- `501` — Unimplemented - The operation is not implemented or supported
- `503` — Unavailable - The service is currently unavailable
- `504` — Deadline exceeded - Upstream service did not respond in time

## Changes

- **2026-09-01** `d1d189d791d1` — 1 warning, 2 info
  - removed the optional property `data/items/relationship` from the response with the `200` status
  - added the new optional `query` request parameter `order_by`
  - added the optional property `data/items/external_user_onboarded_at` to the response with the `200` status
- **2026-08-18** `d3515f9e9eca` — 1 breaking, 1 info
  - the response property `data/items/relationship` became optional for the status `200`
  - added the optional property `data/items/access_type` to the response with the `200` status
- **2026-08-17** `d2b230555b7f` — 3 breaking
  - response property `data/items/external_id` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `data/items/name` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `next_page` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
- **2026-05-06** `a4186730f56c` — 2 info
  - added the optional property `data/items/name` to the response with the `200` status
  - added the required property `data/items/relationship` to the response with the `200` status
- **2026-04-30** `6edc6519fd32` — 1 info
  - the response property `next_page` became required for the status `200`

[Full history](https://skmtc.dev/anthropics/apis/anthropic-api/changes/v1/user_profiles?beta=true/get.md)

---

[API](https://skmtc.dev/anthropics/apis/anthropic-api.md) · [All operations](https://skmtc.dev/anthropics/apis/anthropic-api/llms.txt) · [OpenAPI document](https://skmtc.dev/anthropics/apis/anthropic-api/revisions/1bb7c7a0a4a9?raw)