GET
/
v4
/
users
curl --request GET \
  --url https://api.captaindata.com/v4/users \
  --header 'X-API-Key: <api-key>'
[
  {
    "uid": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2023-10-01T12:00:00Z",
    "workspace_uid": "5678e456-e89b-12d3-a456-426614174001",
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "email": "[email protected]",
    "timezone": "Europe/Paris",
    "integrations": [
      "app1",
      "app2"
    ]
  },
  {
    "uid": "123e4567-e89b-12d3-a456-426614174005",
    "created_at": "2023-10-01T12:05:00Z",
    "workspace_uid": "5678e456-e89b-12d3-a456-426614174001",
    "first_name": "Jane",
    "last_name": "Smith",
    "full_name": "Jane Smith",
    "email": "[email protected]",
    "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

role
enum<string> | null

Filter users by their role in the workspace.

Available options:
external,
user,
ops,
admin
query
string | null

Search users by their full name or email address.

retrieve_accounts
boolean | null

Whether to include associated integrations for each user. 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.
timezone
string
required
uid
string
created_at
string
default:2025-10-01T00:00:00Z
workspace_uid
string | null
first_name
string | null
Maximum length: 255
last_name
string | null
Maximum length: 255
full_name
string | null
email
string | null
integrations
string[]