Get User Profile

get/v1/user_profiles/{user_profile_id}?beta=true

Path parameters

user_profile_idstring required

Path parameter user_profile_id

Headers

x-api-keystring

anthropic-versionstring

anthropic-betastring

Response

Successful response (OK)

idstring required

Unique identifier for this user profile, prefixed uprof_.

type'user_profile' required

Object type. Always user_profile.

external_idstring nullable

Platform's own identifier for this user. Not enforced unique.

namestring nullable

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.

access_type'application' | '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.

external_user_onboarded_atstring date-time nullable

A timestamp in RFC 3339 format

trust_grantsobject required

Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.

created_atstring date-time required

A timestamp in RFC 3339 format

metadataobject required

Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.

updated_atstring date-time required

A timestamp in RFC 3339 format

Example response

{
  "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
  "type": "user_profile",
  "external_id": "user_12345",
  "name": "Example User",
  "access_type": "application",
  "trust_grants": {
    "cyber": {
      "status": "active"
    }
  },
  "external_user_onboarded_at": "2024-11-02T08:15:00Z",
  "metadata": {},
  "created_at": "2026-03-15T10:00:00Z",
  "updated_at": "2026-03-15T10:00:00Z"
}

Changes

Changed in 5 of the 68 revisions of this API.315

Sep 1, 2026d1d189d791d111See the full diff
- ●
  removed the optional property relationship from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property external_user_onboarded_at to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 18, 2026d3515f9e9eca11See the full diff
- ▲
  the response property relationship became optional for the status 200
  response-property-became-optional
- ○
  added the optional property access_type to the response with the 200 status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 17, 2026d2b230555b7f2See the full diff
- ▲
  response property external_id list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property name list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
May 6, 2026a4186730f56c2See the full diff
- ○
  added the optional property name to the response with the 200 status
  response-optional-property-added
- ○
  added the required property relationship to the response with the 200 status
  response-required-property-added
This revision also has 22 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 16, 2026e0696f59ae071See the full diff
- ○
  endpoint added
  endpoint-added

Full history