Pult Docs

List users

Beta

GET
/users

Lists your organization's users, sorted by id. Active users by default; archived users are listed when status asks for them. Users in groups without an active seat are included; guests are not.

Authorization

headerAuthorizationBearer <pult_<base62>>

An API key created by an admin of your organization in the Pult dashboard, sent as Authorization: Bearer <key>. Keys start with pult_.

Query Parameters

status?array<>

Repeatable (status=active&status=archived). Default: active.

Items1 <= items <= 50
groupId?string

Only users whose current group is this group.

email?string

Only the user with this email address (case-insensitive).

Length1 <= length <= 255
cursor?string

Opaque cursor from pagination.nextCursor of the previous page; omit it for the first page.

Length1 <= length
limit?integer

Page size, 1 to 500; default 100.

Range1 <= value <= 500
Default100

Response Body

OK

application/json
  1. response
data*array<>
pagination*

Cursor pagination: nextCursor is null on the last page.

meta*
Example Request
curl -X GET 'https://api.pult.com/v1beta/users' \  -H 'Authorization: Bearer pult_<key>'
Example Response
{  "data": [    {      "id": "string",      "email": "string",      "firstName": "string",      "lastName": "string",      "timeZone": "string",      "status": "active",      "archivedAt": "2019-08-24T14:15:22Z",      "groups": [        {          "id": "string",          "name": "string"        }      ],      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "nextCursor": "string"  },  "meta": {    "status": [      "active"    ]  }}