ReferenceUsers
List users
Beta
GET
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.
header
AuthorizationBearer <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_.
status?array<>Repeatable (status=active&status=archived). Default: active.
Items
1 <= items <= 50groupId?stringOnly users whose current group is this group.
email?stringOnly the user with this email address (case-insensitive).
Length
1 <= length <= 255cursor?stringOpaque cursor from pagination.nextCursor of the previous page; omit it for the first page.
Length
1 <= lengthlimit?integerPage size, 1 to 500; default 100.
Range
1 <= value <= 500Default
100OK
application/json- response
data*array<>pagination*Cursor pagination: nextCursor is null on the last page.
meta*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" ] }}