GET
/
v3
/
users
List all Users
curl --request GET \
  --url https://api.captaindata.co/v3/users \
  --header 'Authorization: <api-key>' \
  --header 'x-project-id: <api-key>'
{
  "users": [
    {
      "uid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "email": "[email protected]",
      "first_name": "Guillaume",
      "last_name": "Odier",
      "full_name": "Guillaume Odier",
      "country": "fr",
      "project_uid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "accounts": [
        {
          "uid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "application_permalink": "linkedin"
        }
      ]
    }
  ],
  "nbr_users": 37,
  "limit": 30,
  "pages": 2,
  "paging": {
    "previous": null,
    "next": "https://api.captaindata.co/v3/users?page=1"
  }
}

Authorizations

​
Authorization
string
header
required

The Authorization header must include 'x-api-key' followed by your API key (e.g., 'Authorization: x-api-key YOUR_API_KEY').

​
x-project-id
string
header
required

Workspace UID required to identify the workspace.

Query Parameters

​
role
string

To search for specific users by role: 'user', 'external', 'admin', and 'owner'.

​
search_term
string

A string used to specify the keyword or phrase to search for within the Users, like an email or a User's name.

​
retrieve_accounts
boolean
default:true

Setting this to TRUE will retrieve the Accounts data, but please note it may take longer to compute.

​
page
integer
default:0

To iterate through the list of Users.

Response

200 - application/json

Successful Response

The response is of type object.