Skip to main content
GET
/
users
Paginated list of employees for this partner
curl --request GET \
  --url https://{host}/api/v1/users \
  --header 'API-key: <api-key>' \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "next": "<string>",
  "previous": "<string>",
  "count": 123,
  "results": [
    {}
  ]
}

Authorizations

Authorization
string
header
required

Sanctum personal access token (access_tokens / partner API settings).

API-key
string
header
required

UUID API key stored for the partner user.

Query Parameters

page
string
default:1
page_size
string
default:25

Response

Paginated users

total
integer
required
next
string | null
required
previous
string | null
required
count
integer
required
results
LengthAwarePaginator · object[]
required