Repository Public
1---2title: Get User Profile3url: https://platform.claude.com/docs/en/api/beta/user_profiles/retrieve4---56# Get User Profile78**GET** `/v1/user_profiles/{user_profile_id}`910Get User Profile1112## Path parameters1314- `user_profile_id: string`1516## Headers1718- `"anthropic-beta": optional array of AnthropicBeta`1920 Optional header to specify the beta version(s) you want to use.2122 - `string`2324 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`2526 - `"message-batches-2024-09-24"`2728 - `"prompt-caching-2024-07-31"`2930 - `"computer-use-2024-10-22"`3132 - `"computer-use-2025-01-24"`3334 - `"pdfs-2024-09-25"`3536 - `"token-counting-2024-11-01"`3738 - `"token-efficient-tools-2025-02-19"`3940 - `"output-128k-2025-02-19"`4142 - `"files-api-2025-04-14"`4344 - `"mcp-client-2025-04-04"`4546 - `"mcp-client-2025-11-20"`4748 - `"dev-full-thinking-2025-05-14"`4950 - `"interleaved-thinking-2025-05-14"`5152 - `"code-execution-2025-05-22"`5354 - `"extended-cache-ttl-2025-04-11"`5556 - `"context-1m-2025-08-07"`5758 - `"context-management-2025-06-27"`5960 - `"model-context-window-exceeded-2025-08-26"`6162 - `"skills-2025-10-02"`6364 - `"fast-mode-2026-02-01"`6566 - `"output-300k-2026-03-24"`6768 - `"user-profiles-2026-03-24"`6970 - `"user-profiles-2026-08-18"`7172 - `"user-profiles-2026-09-04"`7374 - `"advisor-tool-2026-03-01"`7576 - `"managed-agents-2026-04-01"`7778 - `"cache-diagnosis-2026-04-07"`7980 - `"dreaming-2026-04-21"`8182 - `"thinking-token-count-2026-05-13"`8384 - `"server-side-fallback-2026-06-01"`8586 - `"server-side-fallback-2026-07-01"`8788 - `"fallback-credit-2026-06-01"`8990 - `"fallback-credit-2026-07-01"`9192 - `"agent-memory-2026-07-22"`9394 - `"mid-conversation-tool-changes-2026-07-01"`9596 - `"compact-2026-01-12"`9798 - `"computer-use-2025-11-24"`99100 - `"mcp-tunnels-2026-06-22"`101102 - `"structured-outputs-2025-11-13"`103104 - `"task-budgets-2026-03-13"`105106 - `"thinking-display-updates-2026-08-18"`107108 - `"ce-user-management-2026-07-13"`109110 - `"mid-conversation-output-config-2026-07-01"`111112 - `"thinking-binding-controls-2026-08-01"`113114 - `"mid-conversation-system-clear-at-2026-08-21"`115116 - `"compact-2026-09-04"`117118- `"anthropic-workspace-id": optional string`119120## Returns121122- `BetaUserProfile object`123124 - `type: "user_profile"`125126 Object type. Always `user_profile`.127128 - `id: string`129130 Unique identifier for this user profile, prefixed `uprof_`.131132 - `created_at: string`133134 A timestamp in RFC 3339 format135136 format: date-time137138 - `metadata: map[string]`139140 Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.141142 - `trust_grants: map[BetaUserProfileTrustGrant]`143144 Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.145146 - `status: "active" or "pending" or "rejected"`147148 Status of the trust grant.149150 - `"active"`151152 - `"pending"`153154 - `"rejected"`155156 - `updated_at: string`157158 A timestamp in RFC 3339 format159160 format: date-time161162 - `access_type: optional "application" or "passthrough"`163164 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.165166 - `"application"`167168 - `"passthrough"`169170 - `external_id: optional string or null`171172 Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`.173174 - `external_user_details: optional BetaUserProfileExternalUserDetails`175176 Details about the entity this profile represents, as the platform states them. Anthropic does not verify them. Every field is present, `null` until the platform supplies a value.177178 - `account_status: "active" or "suspended" or "blocked" or null`179180 The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it.181182 - `"active"`183184 - `"suspended"`185186 - `"blocked"`187188 - `country: string or null`189190 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.191192 - `email_hash: string or null`193194 The platform-computed hash of the entity's email address. `null` until the platform supplies one.195196 - `entity_type: "individual" or "business" or "non_profit" or "government" or null`197198 What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.199200 - `"individual"`201202 - `"business"`203204 - `"non_profit"`205206 - `"government"`207208 - `name_hash: string or null`209210 The platform-computed hash of the entity's name. `null` until the platform supplies one.211212 - `onboarded_at: string or null`213214 A timestamp in RFC 3339 format215216 format: date-time217218 - `reference_id: string or null`219220 The platform's own reference for the entity. `null` until the platform supplies one.221222 - `external_user_onboarded_at: optional string or null`223224 A timestamp in RFC 3339 format225226 format: date-time227228 - `name: optional string or null`229230 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.231232## Example233234```bash235curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID \236 -H 'anthropic-version: 2023-06-01' \237 -H 'anthropic-beta: user-profiles-2026-08-18' \238 -H "X-Api-Key: $ANTHROPIC_API_KEY"239```240241### Response (200)242243```json244{245 "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",246 "created_at": "2026-03-15T10:00:00Z",247 "metadata": {},248 "trust_grants": {249 "cyber": {250 "status": "active"251 }252 },253 "type": "user_profile",254 "updated_at": "2026-03-15T10:00:00Z",255 "access_type": "application",256 "external_id": "user_12345",257 "external_user_details": {258 "account_status": "active",259 "country": "country",260 "email_hash": "email_hash",261 "entity_type": "individual",262 "name_hash": "name_hash",263 "onboarded_at": "2019-12-27T18:11:19.117Z",264 "reference_id": "reference_id"265 },266 "external_user_onboarded_at": "2024-11-02T08:15:00Z",267 "name": "Example User"268}269```270