ANanthropics

List User Profiles

Changed on
get/v1/user_profiles

Request

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

Query parameters

limitinteger

The maximum number of user profiles to return, from 1 to 100. Defaults to 20.

pagestring

The cursor for the page to return, taken from next_page in a previous response.

Leave it out to get the first page.

order'asc' | 'desc'

The direction that a list of user profiles is sorted in.

The sort direction, applied to the field that order_by selects. Defaults to desc.

order_by'created_at' | 'name'

Sort field for listing user profiles: created_at (default) or name (case-insensitive; profiles without a name sort last).

The field to sort user profiles by, in the direction that order sets. Defaults to created_at.

enforcement_status[]UserProfileEnforcementStatus[]

Return only the user profiles whose enforcement_status is one of these values: unrestricted, pending, restricted or banned. Repeat the parameter to match any of several. With it set, a page may hold fewer than limit profiles, or none, and still carry a next_page: the service examines a bounded number of profiles per request, and only a null next_page means the listing is complete. Rejected with invalid_request_error under the user-profiles-2026-09-04 and earlier beta headers. Fails with overloaded_error when a profile's enforcement actions cannot be read for the moment.

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)

next_pagestring nullable required

Cursor for the next page, or null when there are no more results.

Example response

{
  "data": [
    {
      "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
      "type": "user_profile",
      "name": "Example User",
      "access_type": "application",
      "programs": {
        "cyber": {
          "status": "active",
          "tiers": {},
          "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"
    }
  ],
  "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}

Changes

  • 54a5d04eb67fRevision changes
    • info

      added the new optional query request parameter enforcement_status[]

    • 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