Skip to main content

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

Successfully retrieved the user(s)

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

    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

    URL for the small sized avatar of the user (250x250)

    large uri nullable

    URL for the large sized avatar of the user (500x500)

  • ]
    • 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

Loading...