GET
/
identities
curl --request GET \
  --url https://api.captaindata.com/v4/identities \
  --header 'X-API-Key: <api-key>'
[
  {
    "uid": "123e4567-e89b-12d3-a456-426614174000",
    "workspace_uid": "5678e456-e89b-12d3-a456-426614174001",
    "created_at": "2023-10-01T12:00:00Z",
    "name": "John Doe",
    "timezone": "Europe/Paris",
    "integrations": [
      "app1",
      "app2"
    ]
  },
  {
    "uid": "123e4567-e89b-12d3-a456-426614174005",
    "workspace_uid": "5678e456-e89b-12d3-a456-426614174001",
    "created_at": "2023-10-01T12:05:00Z",
    "name": "Jane Smith",
    "timezone": "America/New_York",
    "integrations": []
  }
]

Authorizations

​
X-API-Key
string
header
required

API key required for authentication. Add your API key in the X-API-Key header.

Query Parameters

​
query
string | null

Search identities by their name.

​
retrieve_accounts
boolean | null

Whether to include associated integrations for each identity. Note: Enabling this will increase response time.

​
page
integer
default:1

The page number to retrieve (1-based indexing).

Required range: x >= 1

Response

200
application/json

Successfully retrieved users.

The response is of type IdentityPublic · object[].

GET
/
identities
curl --request GET \
  --url https://api.captaindata.com/v4/identities \
  --header 'X-API-Key: <api-key>'
[
  {
    "uid": "123e4567-e89b-12d3-a456-426614174000",
    "workspace_uid": "5678e456-e89b-12d3-a456-426614174001",
    "created_at": "2023-10-01T12:00:00Z",
    "name": "John Doe",
    "timezone": "Europe/Paris",
    "integrations": [
      "app1",
      "app2"
    ]
  },
  {
    "uid": "123e4567-e89b-12d3-a456-426614174005",
    "workspace_uid": "5678e456-e89b-12d3-a456-426614174001",
    "created_at": "2023-10-01T12:05:00Z",
    "name": "Jane Smith",
    "timezone": "America/New_York",
    "integrations": []
  }
]

Authorizations

​
X-API-Key
string
header
required

API key required for authentication. Add your API key in the X-API-Key header.

Query Parameters

​
query
string | null

Search identities by their name.

​
retrieve_accounts
boolean | null

Whether to include associated integrations for each identity. Note: Enabling this will increase response time.

​
page
integer
default:1

The page number to retrieve (1-based indexing).

Required range: x >= 1

Response

200
application/json

Successfully retrieved users.

The response is of type IdentityPublic · object[].