List User Profiles
api/beta/user_profiles/list
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/beta/user_profiles/list Changed · +16 / -17 lines
# List User Profiles ## Query parameters ## Headers ## Returns ## Example ### Response (200) ## List User Profiles ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
---- -title: List User Profiles -url: https://platform.claude.com/docs/en/api/beta/user_profiles/list ---- +# List User Profiles -## List User Profiles +**GET** `/v1/user_profiles` -**get** `/v1/user_profiles` - List User Profiles -### Query Parameters +## Query parameters - `limit: optional number` Query parameter for limit + format: int32 + - `order: optional "asc" or "desc"` Query parameter for order
Query parameter for page -### Header Parameters +## Headers - `"anthropic-beta": optional array of AnthropicBeta`
- `"mid-conversation-tool-changes-2026-07-01"` -### Returns +## Returns - `data: array of BetaUserProfile`
A timestamp in RFC 3339 format + format: date-time + - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
Object type. Always `user_profile`. - - `"user_profile"` - - `updated_at: string` A timestamp in RFC 3339 format + format: date-time + - `access_type: optional "application" or "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.
Cursor for the next page, or `null` when there are no more results. -### Example +## Example -```http +```bash curl https://api.anthropic.com/v1/user_profiles \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: user-profiles-2026-08-18' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" ``` -#### Response +### Response (200) ```json {