List User Profiles

get/v1/user_profiles?beta=true

Query parameters

limitinteger

Query parameter for limit

pagestring

Query parameter for page

order'asc' | 'desc'

ListOrder enum

Query parameter for order

Headers

x-api-keystring

anthropic-versionstring

anthropic-betastring

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",
      "external_id": "user_12345",
      "name": "Example User",
      "relationship": "external",
      "trust_grants": {
        "cyber": {
          "status": "active"
        }
      },
      "metadata": {},
      "created_at": "2026-03-15T10:00:00Z",
      "updated_at": "2026-03-15T10:00:00Z"
    }
  ],
  "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}

Changes

Changed in 5 of the 67 revisions of this API.45

Aug 18, 2026d3515f9e9eca11See the full diff
- ▲
  the response property data/items/relationship became optional for the status 200
  response-property-became-optional
- ○
  added the optional property data/items/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, 2026d2b230555b7f3See the full diff
- ▲
  response property data/items/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 data/items/name 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 next_page 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 data/items/name to the response with the 200 status
  response-optional-property-added
- ○
  added the required property data/items/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 30, 20266edc6519fd321See the full diff
- ○
  the response property next_page became required for the status 200
  response-property-became-required
Apr 16, 2026e0696f59ae071See the full diff
- ○
  endpoint added
  endpoint-added

Full history