Get User Profile changedapi/beta/user_profiles/retrieve
Nearest release: v2.1.280, published 20 hours 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.
Recorded here
Lines+20added
Lines−0removed
From line
13
where the diff opens
First seen
14 Aug 2026
this site's first read of the page
Recorded edits22to this page, all time
The whole hunk
from line 13, old and new numbered
/
from line 13
1313
1414- `user_profile_id: string`
1515
16 The ID of the user profile to get (`uprof_...`).
17
1618## Headers
1719
1820- `"anthropic-beta": optional array of AnthropicBeta`
from line 119
117119
118120- `"anthropic-workspace-id": optional string`
119121
122 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
123
124 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
125
120126## Returns
121127
122128- `BetaUserProfile object`
123129
130 A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to.
131
132 A Messages, Message Batches or token counting request can send a profile's `id` in the `anthropic-user-profile-id` header to attribute the request to that entity.
133
124134 - `type: "user_profile"`
125135
126136 Object type. Always `user_profile`.
from line 175
165175
166176 - `"application"`
167177
178 The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default.
179
168180 - `"passthrough"`
169181
182 The user profile represents a company that the platform resells Claude access to.
183
170184 - `external_id: optional string or null`
171185
172186 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`.
from line 195
181195
182196 - `"active"`
183197
198 The platform has neither restricted nor barred the account of the entity that the user profile represents.
199
184200 - `"suspended"`
185201
202 The platform has restricted the account of the entity that the user profile represents and may restore it.
203
186204 - `"blocked"`
205
206 The platform has barred the account of the entity that the user profile represents.
187207
188208 - `country: string or null`
189209
No line in this hunk matches that.