User Profiles changedapi/beta/user_profiles
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+144added
Lines−4removed
From line
115
where the diff opens
First seen
14 Aug 2026
this site's first read of the page
Recorded edits23to this page, all time
The whole hunk
from line 115, old and new numbered
/
from line 115
115115
116116- `"anthropic-workspace-id": optional string`
117117
118 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
119
120 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.
121
118122### Body parameters
119123
120124- `access_type: optional "application" or "passthrough"`
from line 127
123127
124128 - `"application"`
125129
130 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.
131
126132 - `"passthrough"`
127133
134 The user profile represents a company that the platform resells Claude access to.
135
128136- `external_id: optional string or null`
129137
130138 Platform's own identifier for this user. Not enforced unique. Maximum 255 characters. Accepted under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` send `external_user_details.reference_id` instead.
from line 149
141149
142150 - `"active"`
143151
152 The platform has neither restricted nor barred the account of the entity that the user profile represents.
153
144154 - `"suspended"`
145155
156 The platform has restricted the account of the entity that the user profile represents and may restore it.
157
146158 - `"blocked"`
147159
160 The platform has barred the account of the entity that the user profile represents.
161
148162 - `country: optional string or null`
149163
150164 The country of the entity (not of the platform), as the platform determines it: an ISO 3166-1 alpha-2 code in upper case, for example `US`. Only the form, two uppercase ASCII letters, is checked.
from line 219
205219
206220- `BetaUserProfile object`
207221
222 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.
223
224 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.
225
208226 - `type: "user_profile"`
209227
210228 Object type. Always `user_profile`.
from line 267
249267
250268 - `"application"`
251269
270 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.
271
252272 - `"passthrough"`
253273
274 The user profile represents a company that the platform resells Claude access to.
275
254276 - `external_id: optional string or null`
255277
256278 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 287
265287
266288 - `"active"`
267289
290 The platform has neither restricted nor barred the account of the entity that the user profile represents.
291
268292 - `"suspended"`
269293
294 The platform has restricted the account of the entity that the user profile represents and may restore it.
295
270296 - `"blocked"`
271297
298 The platform has barred the account of the entity that the user profile represents.
299
272300 - `country: string or null`
273301
274302 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
from line 396
368396
369397- `limit: optional number`
370398
371 Query parameter for limit
399 The maximum number of user profiles to return, from 1 to 100. Defaults to 20.
372400
373401 format: int32
374402
375403- `order: optional "asc" or "desc"`
376404
377 Query parameter for order
405 The sort direction, applied to the field that `order_by` selects. Defaults to `desc`.
378406
379407 - `"asc"`
380408
409 Oldest first when `order_by` is `created_at`, or names in ascending order when `order_by` is `name`.
410
381411 - `"desc"`
382412
413 Newest first when `order_by` is `created_at`, or names in descending order when `order_by` is `name`. This is the default.
414
383415- `order_by: optional "created_at" or "name"`
384416
385 Query parameter for order_by
417 The field to sort user profiles by, in the direction that `order` sets. Defaults to `created_at`.
386418
387419 - `"created_at"`
388420
421 Sort by when each user profile was created. This is the default.
422
389423 - `"name"`
390424
425 Sort by `name`, ignoring the case of ASCII letters. Profiles without a name come last in either direction.
426
391427- `page: optional string`
392428
393 Query parameter for page
429 The cursor for the page to return, taken from `next_page` in a previous response.
394430
431 Leave it out to get the first page.
432
395433### Headers
396434
397435- `"anthropic-beta": optional array of AnthropicBeta`
from line 534
496534
497535- `"anthropic-workspace-id": optional string`
498536
537 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
538
539 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.
540
499541### Returns
500542
501543- `data: array of BetaUserProfile`
from line 588
546588
547589 - `"application"`
548590
591 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.
592
549593 - `"passthrough"`
550594
595 The user profile represents a company that the platform resells Claude access to.
596
551597 - `external_id: optional string or null`
552598
553599 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 608
562608
563609 - `"active"`
564610
611 The platform has neither restricted nor barred the account of the entity that the user profile represents.
612
565613 - `"suspended"`
566614
615 The platform has restricted the account of the entity that the user profile represents and may restore it.
616
567617 - `"blocked"`
568618
619 The platform has barred the account of the entity that the user profile represents.
620
569621 - `country: string or null`
570622
571623 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
from line 720
668720
669721- `user_profile_id: string`
670722
723 The ID of the user profile to get (`uprof_...`).
724
671725### Headers
672726
673727- `"anthropic-beta": optional array of AnthropicBeta`
from line 826
772826
773827- `"anthropic-workspace-id": optional string`
774828
829 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
830
831 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.
832
775833### Returns
776834
777835- `BetaUserProfile object`
778836
837 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.
838
839 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.
840
779841 - `type: "user_profile"`
780842
781843 Object type. Always `user_profile`.
from line 882
820882
821883 - `"application"`
822884
885 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.
886
823887 - `"passthrough"`
824888
889 The user profile represents a company that the platform resells Claude access to.
890
825891 - `external_id: optional string or null`
826892
827893 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 902
836902
837903 - `"active"`
838904
905 The platform has neither restricted nor barred the account of the entity that the user profile represents.
906
839907 - `"suspended"`
840908
909 The platform has restricted the account of the entity that the user profile represents and may restore it.
910
841911 - `"blocked"`
842912
913 The platform has barred the account of the entity that the user profile represents.
914
843915 - `country: string or null`
844916
845917 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
from line 1005
9331005
9341006- `user_profile_id: string`
9351007
1008 The ID of the user profile to update (`uprof_...`).
1009
9361010### Headers
9371011
9381012- `"anthropic-beta": optional array of AnthropicBeta`
from line 1111
10371111
10381112- `"anthropic-workspace-id": optional string`
10391113
1114 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
1115
1116 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.
1117
10401118### Body parameters
10411119
10421120- `access_type: optional "application" or "passthrough" or null`
from line 1123
10451123
10461124 - `"application"`
10471125
1126 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.
1127
10481128 - `"passthrough"`
10491129
1130 The user profile represents a company that the platform resells Claude access to.
1131
10501132- `external_id: optional string or null`
10511133
10521134 If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters. Accepted under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` send `external_user_details.reference_id` instead.
from line 1145
10631145
10641146 - `"active"`
10651147
1148 The platform has neither restricted nor barred the account of the entity that the user profile represents.
1149
10661150 - `"suspended"`
10671151
1152 The platform has restricted the account of the entity that the user profile represents and may restore it.
1153
10681154 - `"blocked"`
10691155
1156 The platform has barred the account of the entity that the user profile represents.
1157
10701158 - `country: optional string or null`
10711159
10721160 The country of the entity (not of the platform), as the platform determines it: an ISO 3166-1 alpha-2 code in upper case, for example `US`. Only the form, two uppercase ASCII letters, is checked.
from line 1215
11271215
11281216- `BetaUserProfile object`
11291217
1218 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.
1219
1220 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.
1221
11301222 - `type: "user_profile"`
11311223
11321224 Object type. Always `user_profile`.
from line 1263
11711263
11721264 - `"application"`
11731265
1266 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.
1267
11741268 - `"passthrough"`
11751269
1270 The user profile represents a company that the platform resells Claude access to.
1271
11761272 - `external_id: optional string or null`
11771273
11781274 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 1283
11871283
11881284 - `"active"`
11891285
1286 The platform has neither restricted nor barred the account of the entity that the user profile represents.
1287
11901288 - `"suspended"`
11911289
1290 The platform has restricted the account of the entity that the user profile represents and may restore it.
1291
11921292 - `"blocked"`
11931293
1294 The platform has barred the account of the entity that the user profile represents.
1295
11941296 - `country: string or null`
11951297
11961298 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
from line 1390
12881390
12891391- `user_profile_id: string`
12901392
1393 The ID of the user profile to create an enrollment URL for (`uprof_...`).
1394
12911395### Headers
12921396
12931397- `"anthropic-beta": optional array of AnthropicBeta`
from line 1496
13921496
13931497- `"anthropic-workspace-id": optional string`
13941498
1499 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
1500
1501 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.
1502
13951503### Returns
13961504
13971505- `BetaUserProfileEnrollmentURL object`
13981506
1507 A URL to give to the entity that a user profile represents, so that the entity can enroll for a trust grant.
1508
13991509 - `type: "enrollment_url"`
14001510
14011511 Object type. Always `enrollment_url`.
from line 1546
14361546
14371547- `BetaUserProfile object`
14381548
1549 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.
1550
1551 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.
1552
14391553 - `type: "user_profile"`
14401554
14411555 Object type. Always `user_profile`.
from line 1594
14801594
14811595 - `"application"`
14821596
1597 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.
1598
14831599 - `"passthrough"`
14841600
1601 The user profile represents a company that the platform resells Claude access to.
1602
14851603 - `external_id: optional string or null`
14861604
14871605 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 1614
14961614
14971615 - `"active"`
14981616
1617 The platform has neither restricted nor barred the account of the entity that the user profile represents.
1618
14991619 - `"suspended"`
15001620
1621 The platform has restricted the account of the entity that the user profile represents and may restore it.
1622
15011623 - `"blocked"`
15021624
1625 The platform has barred the account of the entity that the user profile represents.
1626
15031627 - `country: string or null`
15041628
15051629 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
from line 1672
15481672
15491673- `BetaUserProfileEnrollmentURL object`
15501674
1675 A URL to give to the entity that a user profile represents, so that the entity can enroll for a trust grant.
1676
15511677 - `type: "enrollment_url"`
15521678
15531679 Object type. Always `enrollment_url`.
from line 1700
15741700
15751701 - `"active"`
15761702
1703 The platform has neither restricted nor barred the account of the entity that the user profile represents.
1704
15771705 - `"suspended"`
15781706
1707 The platform has restricted the account of the entity that the user profile represents and may restore it.
1708
15791709 - `"blocked"`
15801710
1711 The platform has barred the account of the entity that the user profile represents.
1712
15811713 - `country: string or null`
15821714
15831715 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
from line 1754
16221754
16231755 - `"active"`
16241756
1757 The platform has neither restricted nor barred the account of the entity that the user profile represents.
1758
16251759 - `"suspended"`
16261760
1761 The platform has restricted the account of the entity that the user profile represents and may restore it.
1762
16271763 - `"blocked"`
16281764
1765 The platform has barred the account of the entity that the user profile represents.
1766
16291767 - `country: optional string or null`
16301768
16311769 The country of the entity (not of the platform), as the platform determines it: an ISO 3166-1 alpha-2 code in upper case, for example `US`. Only the form, two uppercase ASCII letters, is checked.
from line 1807
16691807### Beta User Profile Trust Grant
16701808
16711809- `BetaUserProfileTrustGrant object`
1810
1811 The status of one trust grant on a user profile, listed in the profile's `trust_grants` map under the grant's name.
16721812
16731813 - `status: "active" or "pending" or "rejected"`
16741814
No line in this hunk matches that.