List users

get

https://management-api.wonderpush.com/v1/users

This calls enables you to export all users, or only a subset of them.

Query Params

fields

array of strings

Comma separated list of fields to return.

fields

offset

int32

Defaults to 0

The number of first results to skip. Ignored when no sorting is provided. For an efficient deep pagination, always start at 0.

limit

int32

Defaults to 50

The number of results to return, or 0 for counting only the results. This number may be adjusted for efficient deep paginations. The actual number of results may be less for the last few pages of an efficient deep pagination.

string

The cursor identifier for fetching the next result page. You should always use the whole URL provided in the pagination.next field of the previous request response. Do not try to reuse this identifier if changing the other parameters, as it is bound to them.

sort

string

Defaults to none

How to sort the results. You can sort on multiple fields. For efficient deep pagination, you should use "none". Eg.: "-creationDate" will give you the most recent users.

creationDateFrom

string

The minimum creationDate of the users to list.

creationDateTo

string

The maximum creationDate of the users to list.

updateDateFrom

string

The minimum updateDate of the users to list.

updateDateTo

string

The maximum updateDate of the users to list.

ids

array of strings

The ids of the users to list. Up to 10000 values. You can use it along with other criteria to further reduce the matching results. You can also use it all alone or with fields, as an efficient way to retrieve all the desired results in a single call, with no pagination.

ids

Response

Language

Credentials

Query

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200