Skip to main content
GET
/
v1
/
{app_id}
/
users
List users
curl --request GET \
  --url https://{defaultHost}/v1/{app_id}/users \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Authorization: <api-key>'
{
  "total_pages": 123,
  "current_page": 123,
  "next_page": 123,
  "prev_page": 123,
  "per_page": 123,
  "users": [
    {
      "id": "usr_1234567890",
      "app_id": "<string>",
      "user_id": "<string>",
      "status": "active",
      "email": "user@example.com",
      "phone": "+1234567890",
      "name": "John Doe",
      "login_count": 123,
      "last_login_at": "2023-11-07T05:31:56Z",
      "email_verified": true,
      "phone_verified": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "user_meta": {
        "first_name": "John",
        "last_name": "Doe",
        "company": "Acme Corp",
        "role": "Developer"
      },
      "sessions": [
        {
          "id": "<string>",
          "device_name": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "last_used_at": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

API Secret token

X-Authorization
string
header
required

User Access token

Path Parameters

app_id
string
required

App ID

Query Parameters

id
string

ID of a specific user

email
string

Email filter

phone
string

Phone filter

status
string

Status filter (active, pending, inactive)

created_before
string<date-time>

Filter users created before this date

page
integer

Page number

limit
integer

Number of results per page (overrides default of 10)

Response

successful

total_pages
integer

Total number of pages

current_page
integer

Current page number

next_page
integer | null

Next page number

prev_page
integer | null

Previous page number

per_page
integer

Items per page

users
object[]

Array of user objects