List Users
GET {{baseUrl}}/apps/:app_id/users?page=<integer>&limit=<integer>&created_before=<integer>&order_by=<string>&identifier=<string>&id=<string>&login_count=<integer>&status=<string>&created_at=<string>&updated_at=<string>&last_login_at=<string>
List users for an app.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
page | string | page to fetch (min=1) | |
limit | string | number of users to fetch per page (max=500) | |
created_before | string | Unix timestamp to anchor pagination results (fetches events that were created before the timestamp) | |
order_by | string | Comma separated list of <field>:<ASC/DESC> (example: order_by=id:DESC,created_at:ASC) **cannot order_by identifier | |
identifier | string | search users email OR phone (pagination prepended operators identifier=<val>, identifier=<ne:val>, identifier=<gt:val>, identifier=<lt:val>, identifier=<like:val>, identifier=<not_like:val>) | |
id | string | search users id (pagination prepended operators id=<val>, id=<ne:val>, id=<gt:val>, id=<lt:val>, id=<like:val>, id=<not_like:val>) | |
login_count | string | search users login_count (pagination prepended operators login_count=<val>, login_count=<ne:val>, login_count=<gt:val>, login_count=<lt:val>) | |
status | string | search users by status (pagination prepended operators status=<val>, status=<ne:val>, status=<gt:val>, status=<lt:val>, status=<like:val>, status=<not_like:val>) -- valid values: (active, inactive, pending) | |
created_at | string | search users created_at (pagination prepended operators created_at=<val>, created_at=<ne:val>, created_at=<gt:val>, created_at=<lt:val> -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required | |
updated_at | string | search users updated_at (pagination prepended operators updated_at=<val>, updated_at=<ne:val>, updated_at=<gt:val>, updated_at=<lt:val> -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required | |
last_login_at | string | search users last_login_at (pagination prepended operators last_login_at=<val>, lat_login_at=<ne:val>, last_login_at=<gt:val>, last_login_at=<lt:val> -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"_links":{"first":{"href":"tempor"},"last":{"href":"adipisicing"},"next":{"href":"nostrud dolor ut"},"previous":{"href":"ullamco incididunt consequat sed"},"self":{"href":"sint eu mollit"}},"created_before":-2553994,"limit":-18400969,"page":-76035865,"total_users":90127927,"users":[{"created_at":"1979-12-09T22:30:34.642Z","email":"anim adipisicing magna","email_verified":false,"external_id":"laboris ut eiusmod","id":"in commodo","last_login_at":"2018-01-28T09:22:19.609Z","login_count":65838270,"phone":"non proident laborum","phone_verified":false,"status":"inactive","updated_at":"1963-05-30T23:42:40.565Z","user_metadata":{}},{"created_at":"1970-12-18T04:49:22.065Z","email":"laborum est","email_verified":false,"external_id":"dolor","id":"adipisicing eiusmod incididunt in cupidatat","last_login_at":"1947-04-10T07:53:53.527Z","login_count":-26109592,"phone":"ut","phone_verified":true,"status":"active","updated_at":"1960-08-10T17:06:19.167Z","user_metadata":{}}]}