Skip to main content

List all numbers​

List all numbers

Query Parameters
    page integer

    Default value: 1

    The page number to retrieve

    perPage integer

    Default value: 10

    The number of items per page

Responses

Successfully retrieved the number(s)

Schema
    data object[]
  • Array [
    • id string

    The ID of the number

    label string nullable

    The label of the number

    number string

    The phone number in E.164 format

    localizedNumber string

    The phone number in localized format

    status string

    Possible values: [ACTIVE, SUSPENDED, CANCELLED, PENDING_CANCEL, PARKED, PENDING_PARKING, PENDING_PORTING_IN, PENDING_REGION_VALIDATION, PENDING_ACTIVATION]

    The status of the number

    activationDate date-time nullable

    The date and time the number was activated

    cancelDate date-time nullable

    The date and time the number was cancelled

    activeUserIds string[]

    An array of active user ids included in the forwarding / voice menu features.

    insights object
    enabled boolean

    Whether insights are enabled for the number

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