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

page
object

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

filter[messaging_profile_id]
string<uuid>

Filter by messaging profile ID.

filter[phone_number]
string

Filter by exact phone number (supports comma-separated list).

filter[phone_number][contains]
string

Filter by phone number substring.

filter[type]
enum<string>

Filter by phone number type.

Available options:
tollfree,
longcode,
shortcode
sort[phone_number]
enum<string>

Sort by phone number.

Available options:
asc,
desc

Response

Successful response with a list of phone numbers with messaging settings.

data
object[]
meta
object