Skip to main content
GET
/
api
/
v1
/
users
List Users
curl --request GET \
  --url https://api.example.com/api/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "jsmith@example.com",
      "external_user_id": "<string>",
      "last_synced_at": "2023-11-07T05:31:56Z",
      "last_synced_provider": "<string>"
    }
  ],
  "total": 1,
  "page": 2,
  "limit": 123,
  "pages": 123,
  "has_next": true,
  "has_prev": true
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Open-Wearables-API-Key
string | null

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 100
sort_by
enum<string> | null
default:created_at
Available options:
created_at,
email,
first_name,
last_name,
last_synced_at
sort_order
enum<string>
default:desc
Available options:
asc,
desc
search
string | null
email
string<email> | null
external_user_id
string | null

Response

Successful Response

items
UserRead · object[]
required
total
integer
required

Total number of items matching the query

Required range: x >= 0
page
integer
required

Current page number (1-based)

Required range: x >= 1
limit
integer
required

Number of items per page

pages
integer
required

Total number of pages.

has_next
boolean
required

Whether there is a next page.

has_prev
boolean
required

Whether there is a previous page.