Sweep 22 Sep 2026 · 17:19Z Build v2.1.280 501 read Stable v2.1.267 Latest v2.1.280 Next v2.1.280 Feeds RSS JSON llms.txt Unofficial
One change · api

User Profiles changed

api/beta/user_profiles

Nearest release: v2.1.258, 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.

Recorded here
Lines+100added
Lines−89removed
From line 14 where the diff opens
First seen 14 Aug 2026 this site's first read of the page
Recorded edits9to this page, all time

The whole hunk

from line 14, old and new numbered
/
lines
from line 14
1414 
1515 - `string`
1616 
17 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more`
17 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1818 
1919 - `"message-batches-2024-09-24"`
2020 
from line 98
9898 
9999 - `"ce-user-management-2026-07-13"`
100100 
101 - `"mid-conversation-output-config-2026-07-01"`
102 
103 - `"thinking-binding-controls-2026-08-01"`
104 
105 - `"mid-conversation-system-clear-at-2026-08-21"`
106 
101107### Body parameters
102108 
103109- `access_type: optional "application" or "passthrough"`
from line 120
114120 
115121 minLength: 1, maxLength: 255
116122 
123- `external_user_onboarded_at: optional string`
124 
125 A timestamp in RFC 3339 format
126 
127 format: date-time
128 
117129- `metadata: optional map[string]`
118130 
119131 Free-form key-value data to attach to this user profile. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters. Values must be non-empty strings.
from line 132
120132 
121133- `name: optional string or null`
122134 
123 Optional for all profiles. Real-world name of the entity this profile represents (company or individual); for a resold-to company (`relationship` `resold` / `access_type` `passthrough`), that company's name where known. Maximum 255 characters.
135 Optional for all profiles. Real-world name of the entity this profile represents (company or individual); for a company the platform resells Claude access to (`access_type` `passthrough`), that company's name where known. Maximum 255 characters.
124136 
125137 minLength: 1, maxLength: 255
126138 
127- `relationship: optional "external" or "resold" or "internal"`
128 
129 How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage.
130 
131 - `"external"`
132 
133 - `"resold"`
134 
135 - `"internal"`
136 
137139### Returns
138140 
139141- `BetaUserProfile object`
from line 190
188190 
189191 Platform's own identifier for this user. Not enforced unique.
190192 
191 - `name: optional string or null`
193 - `external_user_onboarded_at: optional string or null`
192194 
193 Real-world name of the entity this profile represents (company or individual). For a resold-to company (`access_type` `passthrough`, or `relationship` `resold` under the `user-profiles-2026-03-24` header) this is that company's name.
195 A timestamp in RFC 3339 format
194196 
195 - `relationship: optional "external" or "resold" or "internal"`
197 format: date-time
196198 
197 How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage.
199 - `name: optional string or null`
198200 
199 - `"external"`
201 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.
200202 
201 - `"resold"`
202 
203 - `"internal"`
204 
205203### Example
206204 
207205```bash
from line 210
212210 -H "X-Api-Key: $ANTHROPIC_API_KEY" \
213211 -d '{
214212 "external_id": "user_12345",
213 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
215214 "metadata": {}
216215 }'
217216```
from line 231
232231 "updated_at": "2026-03-15T10:00:00Z",
233232 "access_type": "application",
234233 "external_id": "user_12345",
235 "name": "Example User",
236 "relationship": "external"
234 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
235 "name": "Example User"
237236}
238237```
239238 
from line 258
259258 
260259 - `"desc"`
261260 
261- `order_by: optional "created_at" or "name"`
262 
263 Query parameter for order_by
264 
265 - `"created_at"`
266 
267 - `"name"`
268 
262269- `page: optional string`
263270 
264271 Query parameter for page
from line 278
271278 
272279 - `string`
273280 
274 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more`
281 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
275282 
276283 - `"message-batches-2024-09-24"`
277284 
from line 362
355362 
356363 - `"ce-user-management-2026-07-13"`
357364 
365 - `"mid-conversation-output-config-2026-07-01"`
366 
367 - `"thinking-binding-controls-2026-08-01"`
368 
369 - `"mid-conversation-system-clear-at-2026-08-21"`
370 
358371### Returns
359372 
360373- `data: array of BetaUserProfile`
from line 424
411424 
412425 Platform's own identifier for this user. Not enforced unique.
413426 
414 - `name: optional string or null`
427 - `external_user_onboarded_at: optional string or null`
415428 
416 Real-world name of the entity this profile represents (company or individual). For a resold-to company (`access_type` `passthrough`, or `relationship` `resold` under the `user-profiles-2026-03-24` header) this is that company's name.
429 A timestamp in RFC 3339 format
417430 
418 - `relationship: optional "external" or "resold" or "internal"`
431 format: date-time
419432 
420 How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage.
433 - `name: optional string or null`
421434 
422 - `"external"`
435 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.
423436 
424 - `"resold"`
425 
426 - `"internal"`
427 
428437- `next_page: string or null`
429438 
430439 Cursor for the next page, or `null` when there are no more results.
from line 465
456465 "updated_at": "2026-03-15T10:00:00Z",
457466 "access_type": "application",
458467 "external_id": "user_12345",
459 "name": "Example User",
460 "relationship": "external"
468 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
469 "name": "Example User"
461470 }
462471 ],
463472 "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
from line 491
482491 
483492 - `string`
484493 
485 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more`
494 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
486495 
487496 - `"message-batches-2024-09-24"`
488497 
from line 575
566575 
567576 - `"ce-user-management-2026-07-13"`
568577 
578 - `"mid-conversation-output-config-2026-07-01"`
579 
580 - `"thinking-binding-controls-2026-08-01"`
581 
582 - `"mid-conversation-system-clear-at-2026-08-21"`
583 
569584### Returns
570585 
571586- `BetaUserProfile object`
from line 635
620635 
621636 Platform's own identifier for this user. Not enforced unique.
622637 
623 - `name: optional string or null`
638 - `external_user_onboarded_at: optional string or null`
624639 
625 Real-world name of the entity this profile represents (company or individual). For a resold-to company (`access_type` `passthrough`, or `relationship` `resold` under the `user-profiles-2026-03-24` header) this is that company's name.
640 A timestamp in RFC 3339 format
626641 
627 - `relationship: optional "external" or "resold" or "internal"`
642 format: date-time
628643 
629 How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage.
644 - `name: optional string or null`
630645 
631 - `"external"`
646 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.
632647 
633 - `"resold"`
634 
635 - `"internal"`
636 
637648### Example
638649 
639650```bash
from line 670
659670 "updated_at": "2026-03-15T10:00:00Z",
660671 "access_type": "application",
661672 "external_id": "user_12345",
662 "name": "Example User",
663 "relationship": "external"
673 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
674 "name": "Example User"
664675}
665676```
666677 
from line 693
682693 
683694 - `string`
684695 
685 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more`
696 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
686697 
687698 - `"message-batches-2024-09-24"`
688699 
from line 777
766777 
767778 - `"ce-user-management-2026-07-13"`
768779 
780 - `"mid-conversation-output-config-2026-07-01"`
781 
782 - `"thinking-binding-controls-2026-08-01"`
783 
784 - `"mid-conversation-system-clear-at-2026-08-21"`
785 
769786### Body parameters
770787 
771788- `access_type: optional "application" or "passthrough" or null`
from line 799
782799 
783800 minLength: 1, maxLength: 255
784801 
802- `external_user_onboarded_at: optional string`
803 
804 A timestamp in RFC 3339 format
805 
806 format: date-time
807 
785808- `metadata: optional map[string]`
786809 
787810 Key-value pairs to merge into the stored metadata. Keys provided overwrite existing values. To remove a key, set its value to an empty string. Keys not provided are left unchanged. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters.
from line 815
792815 
793816 minLength: 1, maxLength: 255
794817 
795- `relationship: optional "external" or "resold" or "internal" or null`
796 
797 How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage.
798 
799 - `"external"`
800 
801 - `"resold"`
802 
803 - `"internal"`
804 
805818### Returns
806819 
807820- `BetaUserProfile object`
from line 869
856869 
857870 Platform's own identifier for this user. Not enforced unique.
858871 
859 - `name: optional string or null`
872 - `external_user_onboarded_at: optional string or null`
860873 
861 Real-world name of the entity this profile represents (company or individual). For a resold-to company (`access_type` `passthrough`, or `relationship` `resold` under the `user-profiles-2026-03-24` header) this is that company's name.
874 A timestamp in RFC 3339 format
862875 
863 - `relationship: optional "external" or "resold" or "internal"`
876 format: date-time
864877 
865 How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage.
878 - `name: optional string or null`
866879 
867 - `"external"`
880 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.
868881 
869 - `"resold"`
870 
871 - `"internal"`
872 
873882### Example
874883 
875884```bash
from line 908
899908 "updated_at": "2026-03-15T10:00:00Z",
900909 "access_type": "application",
901910 "external_id": "user_12345",
902 "name": "Example User",
903 "relationship": "external"
911 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
912 "name": "Example User"
904913}
905914```
906915 
from line 931
922931 
923932 - `string`
924933 
925 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more`
934 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
926935 
927936 - `"message-batches-2024-09-24"`
928937 
from line 1015
10061015 
10071016 - `"ce-user-management-2026-07-13"`
10081017 
1018 - `"mid-conversation-output-config-2026-07-01"`
1019 
1020 - `"thinking-binding-controls-2026-08-01"`
1021 
1022 - `"mid-conversation-system-clear-at-2026-08-21"`
1023 
10091024### Returns
10101025 
10111026- `BetaUserProfileEnrollmentURL object`
from line 1115
11001115 
11011116 Platform's own identifier for this user. Not enforced unique.
11021117 
1103 - `name: optional string or null`
1118 - `external_user_onboarded_at: optional string or null`
11041119 
1105 Real-world name of the entity this profile represents (company or individual). For a resold-to company (`access_type` `passthrough`, or `relationship` `resold` under the `user-profiles-2026-03-24` header) this is that company's name.
1120 A timestamp in RFC 3339 format
11061121 
1107 - `relationship: optional "external" or "resold" or "internal"`
1122 format: date-time
11081123 
1109 How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage.
1124 - `name: optional string or null`
11101125 
1111 - `"external"`
1112 
1113 - `"resold"`
1114 
1115 - `"internal"`
1126 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.
11161127 
11171128### Beta User Profile Enrollment URL
11181129