List users
GET {{baseUrl}}/v2/users?limit=100&offset=0&sortField=<string>&order=asc&query=<string>
List users with given parameters
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | number | Number of users to retrieve | |
offset | number | Number of users to skip from start | |
sortField | string | Field to use in sorting. Should be one of 'username', 'fullName' and 'insertedAt' | |
order | string | Direction of sorting. Should be one of 'asc' or 'desc' | |
query | string | Field:value combinations with most of user fields to make more advanced searches. Possible fields are username, fullName, blocked, verified, role, locale, timeZone, userAddress and createdAt |
RESPONSES
status: OK
{"requestId":"mollit pariatur esse minim","took":0,"data":[{"id":"aliqua tempor laborum","username":"id et est","fullName":"nisi ad aliqua","role":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"skypeUsername":"laboris","timeZone":"aliquip dolor velit eu","locale":"ipsum in eiusmod ea laboris","userAddress":{"country":"\u003cstring\u003e","state":"\u003cstring\u003e","city":"\u003cstring\u003e","line":"\u003cstring\u003e","zipCode":"\u003cstring\u003e"},"tags":["magna esse reprehenderit","commodo veniam"],"details":{},"blocked":false,"verified":true,"createdAt":"1981-08-03T20:26:45.251Z","mutedUntil":"2000-07-23T05:44:33.041Z","userContacts":[{"to":"est laboris deserunt nisi","id":"tem","contactMethod":"mobile","disabledReason":"reprehenderit proid","enabled":false},{"to":"aute Ut culpa laborum dolor","id":"enim Ut sit ut","contactMethod":"voice","disabledReason":"enim adipisicing","enabled":true}]},{"id":"aliqua qui est","username":"nostrud tempor","fullName":"id reprehenderit","role":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"skypeUsername":"officia exercitation","timeZone":"anim ex","locale":"commodo nisi id occaecat","userAddress":{"country":"\u003cstring\u003e","state":"\u003cstring\u003e","city":"\u003cstring\u003e","line":"\u003cstring\u003e","zipCode":"\u003cstring\u003e"},"tags":["consequat reprehenderit sint","deserunt aliquip dolor aliqua"],"details":{},"blocked":false,"verified":false,"createdAt":"2014-10-24T13:10:48.436Z","mutedUntil":"1977-06-13T16:53:23.708Z","userContacts":[{"to":"qui amet irure","id":"ipsum anim","contactMethod":"sms","disabledReason":"dolore magna id","enabled":true},{"to":"culpa laboris","id":"ut cupidatat laboris","contactMethod":"sms","disabledReason":"do culpa ut","enabled":false}]}],"totalCount":87620269,"paging":{"prev":"aute sunt","next":"sint est","first":"amet incididunt pariatur magna","last":"sed culpa in"}}