Skip to content

Returns a list of users.
deprecated

Request

Security
ApiKeyAuth or BearerAuth
Query
emailstring

email to search for

phone_numberstring

phone number to search for

limitinteger, <= 200

Maximum number of items per page. With upper bound set to 200.

GET
/v1/users
curl -i -X GET \
  '/v1/users?email=string&phone_number=string&limit=200' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A JSON array of users

Bodyapplication/json
dataArray of objects(User)required
pagingobject(Paging)
Response
{
  "data": [
    { … }
  ],
  "paging": {
    "cursors": { … },
    "next_page": "string",
    "prev_page": "string"
  }
}