Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.

Query Parameters

page[number]
integer
default:1

1-based page number. Out-of-range values return an empty page with correct meta.

Required range: x >= 1
Example:

1

page[size]
integer
default:20

Items per page. Maximum 250; values above are clamped to 250.

Required range: 1 <= x <= 250
Example:

20

filter[phone_number][contains]
string

Partial match on phone number. Must contain at least 5 digits.

Example:

"+16035551234"

filter[enterprise_id]
string<uuid>

Filter by enterprise ID.

filter[phone_number][eq]
string

Exact phone-number match (E.164).

Example:

"+16035551234"

filter[source]
enum<string>

Only numbers with this source. Where the phone number is hosted. telnyx: in your Telnyx inventory. external: a number you own that is hosted with another provider.

Available options:
telnyx,
external
Example:

"external"

filter[ownership_status]
enum<string>

Only numbers with this ownership status. removed lists the numbers that were removed, each with its removal_reason and removed_at; removed numbers are not returned otherwise. Result of ongoing ownership checks. verified: the number is with the carrier on record. pending_confirmation: the number's carrier changed, or a periodic ownership re-verification is due; confirm you still own it before confirm_by. flagged: a periodic re-verification went unanswered; the number stays monitored and is not removed, but confirm ownership (POST .../ownership_confirm) to return it to verified. removed: the number is no longer monitored; returned by POST .../ownership_confirm with still_own: false, and when listing numbers with filter[ownership_status]=removed.

Available options:
verified,
flagged,
pending_confirmation,
removed
Example:

"verified"

Response

Paginated list.

List of reputation-monitored phone numbers, each carrying its current reputation data.

data
object[]
required
meta
object
required

JSON:API pagination metadata returned with every paginated list response. Page numbering is 1-based. page_size reports the number of items actually returned in data for this page; the requested size is taken from the page[size] query parameter.