Claude Platform Docs

Listar perfis de usuário

UserProfileListPage UserProfiles.List(parameters, cancellationToken = default)
GET/v1/user_profiles

Listar perfis de usuário

Parameters
UserProfileListParams parameters
IReadOnlyList<UserProfileEnforcementStatus> enforcementStatus⁠Query parameter

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.

Unrestricted("unrestricted")
Pending("pending")
Restricted("restricted")
Banned("banned")
int limit⁠Query parameter

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

formatint32
UserProfileListOrder order⁠Query parameter

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

UserProfileListOrderBy orderBy⁠Query parameter

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

string page⁠Query parameter

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

Leave it out to get the first page.

string workspaceID⁠Header parameter

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.

Returns
class UserProfile { Type = "user_profile"; ID; AccessType; /* 8 more */ }

A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to.

A Messages, Message Batches or token counting request can send a profile's id in the anthropic-user-profile-id header to attribute the request to that entity.

Listar perfis de usuário
using System;
using Anthropic.Models.UserProfiles;

UserProfileListParams parameters = new();

var page = await client.UserProfiles.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}
Returns Examples
Response 200
{
  "data": [
    {
      "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
      "access_type": "application",
      "created_at": "2026-03-15T10:00:00Z",
      "enforcement_actions": [
        {
          "id": "enac_011CZkZCu8hGbp5mYRQgUmz9",
          "action": "verify",
          "expires_at": null,
          "opened_at": "2026-10-02T19:30:00Z",
          "reason": "fraud_or_abuse",
          "type": "restriction"
        }
      ],
      "enforcement_status": "unrestricted",
      "external_user_details": {
        "account_status": "active",
        "country": "US",
        "email_hash": null,
        "entity_type": "business",
        "name_hash": null,
        "onboarded_at": "2024-11-02T08:15:00Z",
        "reference_id": "user_12345"
      },
      "metadata": {},
      "name": "Example User",
      "programs": {
        "cyber": {
          "requirements": {
            "data_retention": true,
            "human_review": true
          },
          "status": "active",
          "tiers": {}
        },
        "efs": {
          "features": {
            "data_retention_exemption": {
              "status": "inactive"
            },
            "cmek": {
              "status": "active"
            },
            "storage": {
              "status": "inactive"
            }
          },
          "status": "active"
        }
      },
      "type": "user_profile",
      "updated_at": "2026-03-15T10:00:00Z"
    }
  ],
  "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}