List all users

List all users

Query Parameters

page integer

Default value: 1

The page number to retrieve

perPage integer

Default value: 10

The number of items per page

includeAvatars boolean

Include avatar display urls in the response for each user

Responses

• 200
• 401

---

Successfully retrieved the user(s)

application/json

Schema

Example (from schema)

---

Schema

data object[]
Array [
id string
The unique id of the user
initials string
The initials of the user
firstName string
The first name of the user
lastName string
The last name of the user
fullName string
The full name of the user
email email
The email address of the user
phoneNumber object
e164 string
The phone number of the user in E.164 format
countryIsoCode string
The country code of the user phone number in ISO 3166-1 alpha-2 format
countryCallingCode number
The country calling code of the user phone number
number string
The phone number of the user without country calling code
availability string
Possible values: [AVAILABLE, UNAVAILABLE]
The availability of the user
avatarUrls object
small uri nullable
Represents the URL for the small sized avatar of the user (250x250)
large uri nullable
Represents the URL for the large sized avatar of the user (500x500)
preferences object
language string
Possible values: [en, nl, es, sv]
Default value: nl
The language of the user in ISO 639-1 format
defaultCountryCode string
Possible values: [NL, BE, ES, SE]
Default value: NL
The default country code of the user in ISO 3166-1 alpha-2 format
defaultOutboundNumber string nullable
The ID of the number that is preselected when making outbound calls
colorMode string
Possible values: [light, dark, system]
The color mode of the user interface
webphone object
ringTone string
Possible values: [ringtone1, ringtone2, ringtone3, ringtone4, ringtone5, ringtone6]
The ringtone of the webphone
ringDevice boolean
Whether or not the Users device should also ring on incoming Webphone calls
callWaiting object
enabled boolean
Whether or not call waiting is enabled for the Webphone
playWaitingTone boolean
Whether or not the waiting tone is played on a new incoming call
notifications object
missedCalls object
enabled boolean
Whether or not missed call notifications are enabled for the user
channels array
The channels on which missed call notifications are sent
callOutsideBusinessHours object
enabled boolean
Whether or not call outside business hours notifications are enabled for the user
channels array
The channels on which call outside business hours notifications are sent
voicemail object
enabled boolean
Whether or not voicemail notifications are enabled for the user
channels array
The channels on which voicemail notifications are sent
insights object
enabled boolean
Default value: true
Whether or not AI insights are enabled for the user
]
meta object

pagination object

totalItems integer

The number of items in the collection

totalPages integer

The number of pages in the collection

currentPage integer

The current page

perPage integer

Possible values: >= 1 and <= 50

The number of items per page

links object

self uri

The url to the first page

first uri

The url to the first page

last uri

The url to the last page

previous uri nullable

The url to the previous page

next uri nullable

The url to the next page

{
  "data": [
    {
      "id": "64a6b60be7ce3a7774155263",
      "initials": "JD",
      "firstName": "John",
      "lastName": "Doe",
      "fullName": "John Doe",
      "email": "[email protected]",
      "phoneNumber": {
        "e164": "+31612345678",
        "countryIsoCode": "NL",
        "countryCallingCode": 31,
        "number": "612345678"
      },
      "availability": "AVAILABLE",
      "avatarUrls": {
        "small": "https://api.rinkel.com/users/64a6b60be7ce3a7774155263/avatar/small?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
        "large": "https://api.rinkel.com/users/64a6b60be7ce3a7774155263/avatar/large?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
      },
      "preferences": {
        "language": "nl",
        "defaultCountryCode": "NL",
        "defaultOutboundNumber": "64b8e900cbe7501ee8467d3e",
        "colorMode": "light",
        "webphone": {
          "ringTone": "ringtone1",
          "ringDevice": true,
          "callWaiting": {
            "enabled": true,
            "playWaitingTone": true
          }
        }
      },
      "notifications": {
        "missedCalls": {
          "enabled": true,
          "channels": [
            "email"
          ]
        },
        "callOutsideBusinessHours": {
          "enabled": true,
          "channels": [
            "email",
            "app"
          ]
        },
        "voicemail": {
          "enabled": true,
          "channels": [
            "email",
            "app"
          ]
        }
      },
      "insights": {
        "enabled": true
      }
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 100,
      "totalPages": 10,
      "currentPage": 1,
      "perPage": 10
    },
    "links": {
      "self": "https://api.rinkel.com/users?page=1",
      "first": "https://api.rinkel.com/users?page=1",
      "last": "https://api.rinkel.com/users?page=10",
      "previous": null,
      "next": "https://api.rinkel.com/users?page=2"
    }
  }
}

Unauthorized

Loading...