Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter[messaging_profile_id]
string<uuid>

Filter by messaging profile ID.

filter[phone_number]
string

Filter by exact phone number.

filter[phone_number][contains]
string

Filter by phone number substring.

sort[phone_number]
enum<string>

Sort by phone number.

Available options:
asc,
desc
page[number]
integer
default:1

Page number to retrieve (1-based).

page[size]
integer
default:20

Number of items to return per page.

Response

Successful response with a list of hosted numbers.

data
object[]
meta
object