List all users
GET {{baseUrl}}/api/v2/users
Get the list of all users in the organization. This list includes all users even if they are deactivated or unverified.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page[size] | number | Size for a given page. The maximum allowed value is 100. | |
page[number] | number | Specific page number to return. | |
sort | string | User attribute to order results by. Sort order is ascending by default. | |
| Sort order is descending if the field | |||
is prefixed by a negative sign, for example sort=-name. Options: name, | |||
modified_at, user_count. | |||
sort_dir | string | Direction of sort. Options: asc, desc. | |
filter | string | Filter all users by the given string. Defaults to no filtering. | |
filter[status] | string | Filter on status attribute. | |
Comma separated list, with possible values Active, Pending, and Disabled. | |||
| Defaults to no filtering. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"attributes":{"created_at":"2016-06-21T01:04:16.799Z","disabled":true,"email":"laborum labore nulla","handle":"sed anim ipsum","icon":"elit nisi dolore Excepteur ut","modified_at":"1987-05-21T03:58:08.624Z","name":"Lorem","service_account":false,"status":"consequat Ut aliquip","title":"aliqua tempor","verified":false},"id":"adipisicing Duis","relationships":{"org":{"data":{"id":"00000000-0000-beef-0000-000000000000","type":"orgs"}},"other_orgs":{"data":[]},"other_users":{"data":[]},"roles":{"data":[{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"},{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"}]}},"type":"users"},{"attributes":{"created_at":"2019-02-23T06:01:44.457Z","disabled":false,"email":"sint eiusmod Ut consequat","handle":"occaecat ullamco incididunt eu","icon":"Ut dolor","modified_at":"1946-04-15T11:31:03.027Z","name":"non id","service_account":true,"status":"Excepteur D","title":"mollit in aute anim proident","verified":true},"id":"ei","relationships":{"org":{"data":{"id":"00000000-0000-beef-0000-000000000000","type":"orgs"}},"other_orgs":{"data":[]},"other_users":{"data":[]},"roles":{"data":[{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"},{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"}]}},"type":"users"}],"included":[{"type":"orgs","attributes":{"created_at":"1957-02-12T18:48:25.171Z","description":"consequat in commodo adipisicing","disabled":true,"modified_at":"2005-01-30T19:04:56.267Z","name":"consequat sit","public_id":"tempor consequat proident","sharing":"cillum proident incididunt","url":"a"},"id":"eiusmod ut Lorem fugiat"},{"type":"orgs","attributes":{"created_at":"2015-10-18T08:46:20.466Z","description":"in ut","disabled":true,"modified_at":"1979-12-20T09:40:53.251Z","name":"mollit irure ad ipsum","public_id":"dolor id","sharing":"elit nulla","url":"nisi in"},"id":"deserunt amet"}],"meta":{"page":{"total_count":-17566972,"total_filtered_count":91760735}}}