Sign in

v3

latestOpenAPI 3.1.02026-07-31121144224.9 KB
External: Users

List Users

List users with pagination, sorting, and search.

get/api/v1/users

Query parameters

pageinteger

Page number (1-based)

Page number (1-based)

limitinteger

Number of results per page

Number of results per page

sort_by'created_at' | 'email' | 'first_name' | 'last_name' | 'last_synced_at' nullable

Field to sort by

Field to sort by

sort_order'asc' | 'desc'

Sort order

Sort order

searchstring nullable

Search across first_name, last_name, and email (partial match)

Search across first_name, last_name, and email (partial match)

emailstring email nullable

Filter by exact email

Filter by exact email

external_user_idstring nullable

Filter by external user ID. Deprecated: no data-fetching endpoint (timeseries, workouts, sleep, summaries, health-scores, etc.) accepts external_user_id - they all require the Open Wearables UUID. This field was added early in the project but never wired into those endpoints, so it only works as a filter on GET /users. Store the UUID returned by POST /users in your own system instead.

Filter by external user ID. Deprecated: no data-fetching endpoint (timeseries, workouts, sleep, summaries, health-scores, etc.) accepts external_user_id - they all require the Open Wearables UUID. This field was added early in the project but never wired into those endpoints, so it only works as a filter on GET /users. Store the UUID returned by POST /users in your own system instead.

Headers

X-Open-Wearables-API-Keystring nullable

Response

Successful Response

totalinteger required

Total number of items matching the query

pageinteger required

Current page number (1-based)

limitinteger required

Number of items per page

pagesinteger required

Total number of pages.

has_nextboolean required

Whether there is a next page.

has_prevboolean required

Whether there is a previous page.