Get all Users in a paginated listing.
Get all Users in a paginated listing.
Query Parameters
- page integer
Possible values:
>= 1
Default value:
1
The page number in a paginated listing.
- items integer
Possible values:
>= 1
and<= 20
Default value:
20
The number of items to return on each page.
- externalId string
Filter records by
externalId
Responses
- 200
All the users in a paginated listing.
- application/json
- Schema
- Example (from schema)
Schema
users object[]
Array [type string requiredPossible values: [
User
]id uuid requiredexternalId stringgivenName stringfamilyName stringprovisioningInitiatedAt RFC3339unreadMessagesCount integer required]meta object
next_url urlURL for the next page.
count integerThe total count of items.
items integerThe number of returned items on this page.
pages integerThe number of pages.
from integerIndex of the first item on this page (starting from 1).
to integerIndex of the last item on this page.
{
"users": [
{
"type": "User",
"id": "31566c16-c5c4-4ea2-9ec9-4708a2edec2e",
"externalId": "10002345",
"givenName": "Erika",
"familyName": "Mustermann",
"provisioningInitiatedAt": "2006-01-02T15:04:05Z",
"unreadMessagesCount": 2
}
],
"meta": true
}
Loading...