This calls enables you to export all users, or only a subset of them.
Search and list users. This calls enables you to export all users, or only a subset of them. You can restrict results from a given time window. For efficient deep pagination, you must use sort=none
, using a large offset is prohibited.
The result is comprised of a data
array, and a pagination
object containing previous
and next
, two complete URLs for navigating through the result set. Always use the URLs as is and do not add or remove parameters. When doing efficient deep pagination, only the pagination.next
page is available. See Pagination for more help on how to iterate over all results.
You can give only the ids
parameter, or ids
along with fields
, as a mean to efficiently retrieve up to 10000 results in a single call. The limit
parameter is simply ignored in such a scenario.
The result data
array will contain every object found, with no null for missing objects, in no guaranteed order. Use the id
field in each object to find the objects you were looking for.
Note that the total size of a GET
request is limited. To come around this limitation, you can wrap your call within a request to POST /v1/batch
.