Get User Profile
api/beta/user_profiles/retrieve
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/retrieve Changed · +13 / -16 lines
# Get User Profile ## Path parameters ## Headers ## Returns ## Example ### Response (200) ## Get User Profile ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
---- -title: Get User Profile -url: https://platform.claude.com/docs/en/api/beta/user_profiles/retrieve ---- +# Get User Profile -## Get User Profile +**GET** `/v1/user_profiles/{user_profile_id}` -**get** `/v1/user_profiles/{user_profile_id}` - Get User Profile -### Path Parameters +## Path parameters - `user_profile_id: string` -### Header Parameters +## Headers - `"anthropic-beta": optional array of AnthropicBeta`
- `"mid-conversation-tool-changes-2026-07-01"` -### Returns +## Returns -- `BetaUserProfile object { id, created_at, metadata, 7 more }` +- `BetaUserProfile object` - `id: string`
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.
- `"internal"` -### Example +## Example -```http +```bash curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID \ -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 {