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.

Path Parameters

dir_id
string<uuid>
required

The DIR id. Lowercase UUID.

Example:

"16635d38-75a6-4481-82e8-69af60e05011"

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

status
enum<string>

Filter by phone-number status. Phone-number lifecycle status.

  • submitted / in_review - Telnyx is reviewing the batch this number belongs to.
  • verified - approved; the DIR's display identity will be shown on outbound calls from this number.
  • unsuccessful - Telnyx rejected this submission; the customer may re-add to retry.
  • suspended - temporarily disabled (e.g. by an active infringement claim on the DIR).
  • expired - verification expired; re-add to renew.
  • permanently_rejected - terminal; cannot be re-added on this or any other DIR you own.
Available options:
submitted,
in_review,
verified,
unsuccessful,
suspended,
expired,
permanently_rejected

Response

Paginated list of phone numbers.

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.