ANanthropics

Get User Profile

Changed on
get/v1/user_profiles/{user_profile_id}

Request

  • Base URL
    https://api.anthropic.com
  • Auth
    none declared

Path parameters

user_profile_idstring required

The ID of the user profile to get (uprof_...).

Headers

anthropic-versionstring

The version of the Claude API you want to use.

Read more about versioning and our version history here.

anthropic-workspace-idstring

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

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.

Response

Successful response (OK)

idstring required

Unique identifier for this user profile, prefixed uprof_.

type'user_profile' required

Object type. Always user_profile.

namestring nullable required

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. null until the platform supplies one.

access_type'application' | 'passthrough' required

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.

enforcement_status'unrestricted' | 'pending' | 'restricted' | 'banned' required

Anthropic's enforcement status of this profile: unrestricted, pending, restricted or banned. More values may be added; read a value you do not recognize as restricted.

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",
  "name": "Example User",
  "access_type": "application",
  "programs": {
    "cyber": {
      "status": "active",
      "tiers": {
        "a": {
          "status": "inactive"
        },
        "b": {
          "status": "inactive"
        },
        "c": {
          "status": "inactive"
        }
      },
      "requirements": null
    },
    "efs": null
  },
  "external_user_details": {
    "reference_id": "user_12345",
    "onboarded_at": "2024-11-02T08:15:00Z",
    "account_status": "active",
    "entity_type": "business",
    "country": "US",
    "name_hash": null,
    "email_hash": null
  },
  "enforcement_status": "unrestricted",
  "enforcement_actions": [],
  "metadata": {},
  "created_at": "2026-03-15T10:00:00Z",
  "updated_at": "2026-03-15T10:00:00Z"
}

Changes

  • 54a5d04eb67fRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 94c83daca660Revision changes
    • warning

      deleted the header request parameter x-api-key