Claude Platform Docs

列出使用者設定檔

$ ant beta:user-profiles list
GET/v1/user_profiles

列出使用者設定檔

Parameters
--limit: optional number

Query param: Query parameter for limit

formatint32
--order: optional "asc" or "desc"

Query param: Query parameter for order

--order-by: optional "created_at" or "name"

Query param: Query parameter for order_by

--page: optional string

Query param: Query parameter for page

--beta: optional array of AnthropicBeta

Header param: Optional header to specify the beta version(s) you want to use.

Returns
BetaListUserProfilesResponse: object{ data, next_page }
data: array of BetaUserProfile { id, created_at, metadata, 7 more }

User profiles on this page.

id: string

Unique identifier for this user profile, prefixed uprof_.

created_at: string

A timestamp in RFC 3339 format

formatdate-time
metadata: map[string]

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

trust_grants: map[BetaUserProfileTrustGrant { status }]

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

status: "active" or "pending" or "rejected"

Status of the trust grant.

One of the following:
"active"
"pending"
"rejected"
type: "user_profile"

Object type. Always user_profile.

updated_at: string

A timestamp in RFC 3339 format

formatdate-time
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.

One of the following:
"application"
"passthrough"
external_id: optional string

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

external_user_onboarded_at: optional string

A timestamp in RFC 3339 format

formatdate-time
name: optional string

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.

next_page: string

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

列出使用者設定檔
ant beta:user-profiles list \
  --api-key my-anthropic-api-key
Returns Examples
Response 200
{
  "data": [
    {
      "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
      "created_at": "2026-03-15T10:00:00Z",
      "metadata": {},
      "trust_grants": {
        "cyber": {
          "status": "active"
        }
      },
      "type": "user_profile",
      "updated_at": "2026-03-15T10:00:00Z",
      "access_type": "application",
      "external_id": "user_12345",
      "external_user_onboarded_at": "2024-11-02T08:15:00Z",
      "name": "Example User"
    }
  ],
  "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}