Get all Users in a paginated listing.

GET 
/users

Get all Users in a paginated listing.

Request

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

Schema

users

object[]

Array [

type stringrequired

Possible values: [User]

id uuidrequired

externalId string

givenName string

familyName string

provisioningInitiatedAt RFC3339

unreadMessagesCount integerrequired

]

meta

object

next_url url

URL for the next page.

count integer

The total count of items.

items integer

The number of returned items on this page.

pages integer

The number of pages.

from integer

Index of the first item on this page (starting from 1).

to integer

Index of the last item on this page.

Example (from schema)

{
  "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...