Skip to main content
GET
/
users
List users
curl --request GET \
  --url https://api.wacht.dev/users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "1234567890",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-20T15:45:00Z",
      "first_name": "John",
      "last_name": "Doe",
      "username": "johndoe",
      "profile_picture_url": "https://cdn.wacht.dev/deployments/123/users/456/profile.jpg",
      "primary_email_address": "[email protected]",
      "primary_phone_number": "+1234567890"
    }
  ],
  "has_more": true,
  "limit": 10,
  "offset": 0
}

Authorizations

​
Authorization
string
header
required

API key authentication (Bearer token)

Query Parameters

​
limit
integer
default:10

Number of items to return per page

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of items to skip

Required range: x >= 0
​
sort_key
enum<string>
default:created_at

Field to sort by

Available options:
created_at,
username,
email,
phone_number
​
sort_order
enum<string>
default:desc

Sort order (ascending or descending)

Available options:
asc,
desc
​
search
string

Search query to filter results

Response

List of users retrieved successfully

​
data
object[]
required
​
has_more
boolean
required

Whether there are more results available

​
limit
integer | null

Number of items per page

​
offset
integer | null

Number of items skipped