Skip to main content

List phone numbers

GET 
/v1/businesses/{businessId}/phone-numbers

Lists a business's phone numbers. Supports filtering, sorting, and paging.

Path Parameters​

    businessId string<uuid>required

    The ID of the business, assigned by Hiya.

    Example: 9b8a1c4e-2c0f-4f3d-9a1e-7b3a2b4c6d8f

Query Parameters​

    search string

    Matches part of a phone number (case-insensitive).

    Possible values: non-empty and <= 200 characters

    Example: 2065
    status string

    Return only numbers with this status. Lowercase form of the 

    PhoneStatus
    values (e.g. 
    pending
    ).

    Possible values: [pending, registered, needs_attention]

    sortBy string

    Field to sort by.

    Possible values: [phoneNumber, displayName, callReason, createdAt, updatedAt]

    Default value: createdAt
    sortDirection string

    Sort direction. 

    asc
    or 
    desc
    (case-insensitive).

    Possible values: Value must match regular expression ^[Aa][Ss][Cc]$|^[Dd][Ee][Ss][Cc]$

    Default value: desc
    page integer

    Page number, starting at 0.

    Possible values: >= 0

    Default value: 0
    size integer

    Number of items per page.

    Possible values: >= 1 and <= 200

    Default value: 50

Responses​

A page of phone numbers.

Response Body

application/json