List Users

Retrieve all users for a current account.

Find more examples of the request by clicking the dropdown "v" button next to the "LIST USERS" request title here 👉

Search operators

The request can contain all, some or none of these parameters. If this option is set, its value is the object to validate. For example, if a created_at value is specified, the request will return only instances created at created_at time. Filters require an exact match property values ​​with an instance of the corresponding parameter value.

Operator

Description

gt

Greater Than operator

Types: number, string, date

Applicable to fields: id, created_at, updated_at, last_request_at, external_user_id, facebook_id

Example:
filter[]=number+external_user_id+gt+33
filter[]=date+updated_at+gt+2019-05-23T18:07:19Z

Will return users with external_user_id greater than 33.
Will return users with updated_at greater than 2019-05-23T18:07:19Z.

lt

Less Than operator

Types: number, string, date

Applicable to fields: id, created_at, updated_at, last_request_at, external_user_id, facebook_id

Example:
filter[]=number+id+lt+85000
filter[]=date+last_request_at+lt+2019-05-23T18:07:19Z

Will return users with IDs less than 85000.
Will return users with last_request_at less than 2019-05-23T18:07:19Z.

ge

Greater or Equal to operator

Types: number, string, date

Applicable to fields: id, created_at, updated_at, last_request_at, external_user_id, facebook_id

Example:
filter[]=number+facebook_id+ge+34524
filter[]=date+last_request_at+ge+2019-05-23T18:07:19Z

Will return users with facebook_id greater than or equal to 34524.
Will return users with last_request_at greater than or equal to 2019-05-23T18:07:19Z.

le

Less or Equal to operator

Types: number, string, date

Applicable to fields: id, created_at, updated_at, last_request_at, external_user_id, facebook_id

Example:
filter[]=number+facebook_id+le+34524
filter[]=date+created_at+le+2019-05-23T18:07:19Z

Will return users with facebook_id less than or equal 34524.
Will return users with created_at less than or equal 2019-05-23T18:07:19Z.

eq

Equal to operator

Types:number, string, date

Applicable to fields: id, full_name, email, login, phone, created_at, updated_at, last_request_at, external_user_id, facebook_id

Example:
filter[]=number+facebook_id+eq+810
filter[][email protected]
filter[]=date+created_at+eq+2019-04-22

Will return a user with facebook_id equal to 810.
Will return a user with email equal to [email protected]
Will return a user with created_at equal to 2019-04-22.

ne

Not Equal to operator

Types: number, string, date

Applicable to fields: id, full_name, email, login, phone, created_at, updated_at, last_request_at, external_user_id, facebook_id

Example:
filter[]=number+external_user_id +ne+810
filter[][email protected]
filter[]=date+created_at+ne+2019-04-22T19:07:19Z

Will return users with external_user_id not equal to 810.
Will return users with email not equal to [email protected]
Will return users with created_at not equal to 2019-04-22T19:07:19Z.

between

Contained Between values operator

Types: number, string, date

Applicable to fields: id, created_at, updated_at, last_request_at, external_user_id, facebook_id

Example: filter[]=number+external_user_id+between+33,1000
filter[]=date+updated_at+between+2019-04-22T19:07:19Z,2019-04-23T11:04:03Z

Will return users with external_user_id between 3 and 1000.
Will return users with updated_at between 2019-04-22T19:07:19Z and 2019-04-23T11:04:03Z.

in

Contained IN array operator

Types: number, string, date

Applicable to fields: id, full_name, email, login, phone, created_at, updated_at, last_request_at, external_user_id, facebook_id

Example:
filter[]=number+external_user_id+in+33,555
filter[][email protected],[email protected]
filter[]=date+created_at+in+2019-04-22T19:07:19Z,2019-04-22T19:08:38Z

Will return users with external_user_id 33 and 555.
Will return users with email [email protected] and [email protected]
Will return users with created_at 2019-04-22T19:07:19Z and 2019-04-22T19:08:38Z.

Sort operators

There can be any of the below-specified parameters or nothing in the query as the value for sorting. If there are other parameters within the query, the validation error is returned.

Param

Possible values

Description

order

asc, desc

Types: string, number, date

Applicable to fields: id, full_name, email, login, phone, website, created_at, updated_at,
last_request_at, external_user_id

Example: order=asc+date
+last_request_at

Will return users with the last_request_at sorted in the ascending order.

Language