One change
User Profiles
api/beta/user_profiles
Nearest release: v2.1.238, published under 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 Changed · +258 / -188 lines
from line 19
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
from line 65
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
from line 91
### Body Parameters +- `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. + + - `"application"` + + - `"passthrough"` + - `external_id: optional string or null` Platform's own identifier for this user. Not enforced unique. Maximum 255 characters.
from line 109
- `name: optional string or null` - Display name of the entity this profile represents. Required when relationship is `resold` (the resold-to company's name); optional otherwise. Maximum 255 characters. + 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. - `relationship: optional "external" or "resold" or "internal"`
from line 123
### Returns -- `BetaUserProfile object { id, created_at, metadata, 6 more }` +- `BetaUserProfile object { id, created_at, metadata, 7 more }` - `id: string`
from line 137
Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - - `relationship: "external" or "resold" or "internal"` - - 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. - - - `"external"` - - - `"resold"` - - - `"internal"` - - `trust_grants: map[BetaUserProfileTrustGrant]` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.
from line 161
A timestamp in RFC 3339 format + - `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. + + - `"application"` + + - `"passthrough"` + - `external_id: optional string or null` Platform's own identifier for this user. Not enforced unique.
from line 175
- `name: optional string or null` - Display name of the entity this profile represents. For `resold` this is the resold-to company's name. + 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. + - `relationship: optional "external" or "resold" or "internal"` + + 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. + + - `"external"` + + - `"resold"` + + - `"internal"` + ### Example ```http
from line 193
curl https://api.anthropic.com/v1/user_profiles \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ - -H 'anthropic-beta: user-profiles-2026-03-24' \ + -H 'anthropic-beta: user-profiles-2026-08-18' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "external_id": "user_12345",
from line 208
"id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, - "relationship": "external", "trust_grants": { "cyber": { "status": "active"
from line 215
}, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", + "access_type": "application", "external_id": "user_12345", - "name": "Example User" + "name": "Example User", + "relationship": "external" } ```
from line 254
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
from line 300
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
from line 342
Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - - `relationship: "external" or "resold" or "internal"` - - 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. - - - `"external"` - - - `"resold"` - - - `"internal"` - - `trust_grants: map[BetaUserProfileTrustGrant]` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.
from line 366
A timestamp in RFC 3339 format + - `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. + + - `"application"` + + - `"passthrough"` + - `external_id: optional string or null` Platform's own identifier for this user. Not enforced unique.
from line 380
- `name: optional string or null` - Display name of the entity this profile represents. For `resold` this is the resold-to company's name. + 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. + - `relationship: optional "external" or "resold" or "internal"` + + 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. + + - `"external"` + + - `"resold"` + + - `"internal"` + - `next_page: string or null` Cursor for the next page, or `null` when there are no more results.
from line 401
```http curl https://api.anthropic.com/v1/user_profiles \ -H 'anthropic-version: 2023-06-01' \ - -H 'anthropic-beta: user-profiles-2026-03-24' \ + -H 'anthropic-beta: user-profiles-2026-08-18' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ```
from line 414
"id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, - "relationship": "external", "trust_grants": { "cyber": { "status": "active"
from line 421
}, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", + "access_type": "application", "external_id": "user_12345", - "name": "Example User" + "name": "Example User", + "relationship": "external" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
from line 449
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
from line 495
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
from line 521
### Returns -- `BetaUserProfile object { id, created_at, metadata, 6 more }` +- `BetaUserProfile object { id, created_at, metadata, 7 more }` - `id: string`
from line 535
Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - - `relationship: "external" or "resold" or "internal"` - - 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. - - - `"external"` - - - `"resold"` - - - `"internal"` - - `trust_grants: map[BetaUserProfileTrustGrant]` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.
from line 559
A timestamp in RFC 3339 format + - `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. + + - `"application"` + + - `"passthrough"` + - `external_id: optional string or null` Platform's own identifier for this user. Not enforced unique.
from line 573
- `name: optional string or null` - Display name of the entity this profile represents. For `resold` this is the resold-to company's name. + 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. + - `relationship: optional "external" or "resold" or "internal"` + + 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. + + - `"external"` + + - `"resold"` + + - `"internal"` + ### Example ```http curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID \ -H 'anthropic-version: 2023-06-01' \ - -H 'anthropic-beta: user-profiles-2026-03-24' \ + -H 'anthropic-beta: user-profiles-2026-08-18' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ```
from line 601
"id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, - "relationship": "external", "trust_grants": { "cyber": { "status": "active"
from line 608
}, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", + "access_type": "application", "external_id": "user_12345", - "name": "Example User" + "name": "Example User", + "relationship": "external" } ```
from line 633
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
from line 679
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
from line 705
### Body Parameters +- `access_type: optional "application" or "passthrough" or null` + + 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. + + - `"application"` + + - `"passthrough"` + - `external_id: optional string or null` If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters.
from line 737
### Returns -- `BetaUserProfile object { id, created_at, metadata, 6 more }` +- `BetaUserProfile object { id, created_at, metadata, 7 more }` - `id: string`
from line 751
Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - - `relationship: "external" or "resold" or "internal"` - - 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. - - - `"external"` - - - `"resold"` - - - `"internal"` - - `trust_grants: map[BetaUserProfileTrustGrant]` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.
from line 775
A timestamp in RFC 3339 format + - `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. + + - `"application"` + + - `"passthrough"` + - `external_id: optional string or null` Platform's own identifier for this user. Not enforced unique.
from line 789
- `name: optional string or null` - Display name of the entity this profile represents. For `resold` this is the resold-to company's name. + 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. + - `relationship: optional "external" or "resold" or "internal"` + + 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. + + - `"external"` + + - `"resold"` + + - `"internal"` + ### Example ```http
from line 807
curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ - -H 'anthropic-beta: user-profiles-2026-03-24' \ + -H 'anthropic-beta: user-profiles-2026-08-18' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "external_id": "user_12345"
from line 821
"id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, - "relationship": "external", "trust_grants": { "cyber": { "status": "active"
from line 828
}, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", + "access_type": "application", "external_id": "user_12345", - "name": "Example User" + "name": "Example User", + "relationship": "external" } ```
from line 853
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
from line 899
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
from line 947
curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID/enrollment_url \ -X POST \ -H 'anthropic-version: 2023-06-01' \ - -H 'anthropic-beta: user-profiles-2026-03-24' \ + -H 'anthropic-beta: user-profiles-2026-08-18' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ```
from line 965
### Beta User Profile -- `BetaUserProfile object { id, created_at, metadata, 6 more }` +- `BetaUserProfile object { id, created_at, metadata, 7 more }` - `id: string`
from line 979
Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - - `relationship: "external" or "resold" or "internal"` - - 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. - - - `"external"` - - - `"resold"` - - - `"internal"` - - `trust_grants: map[BetaUserProfileTrustGrant]` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.
from line 1003
A timestamp in RFC 3339 format + - `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. + + - `"application"` + + - `"passthrough"` + - `external_id: optional string or null` Platform's own identifier for this user. Not enforced unique.
from line 1017
- `name: optional string or null` - Display name of the entity this profile represents. For `resold` this is the resold-to company's name. + 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. + + - `relationship: optional "external" or "resold" or "internal"` + + 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. + + - `"external"` + + - `"resold"` + + - `"internal"` ### Beta User Profile Enrollment URL