Skip to main content

Get the user​

Get the user

Path Parameters
    id string required

    The ID of the user to get

Responses

The user

Schema
    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

Loading...