Skip to main content
GET
Export the number inventory as CSV or JSON

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Query Parameters

format
enum<string>
default:csv

Output format — a CSV attachment (default) or a JSON array.

Available options:
csv,
json
status
string

Status filter (e.g. active); defaults to all so released/parked-but-still-billable rows are included.

country_code
string

ISO 3166-1 alpha-2 country filter.

Free-text match on the phone number or label.

tz
string

IANA timezone for CSV timestamp columns (e.g. Europe/Istanbul); JSON stays canonical UTC.

locale
string

BCP-47 locale for CSV date formatting (defaults to en-US).

Response

The inventory export as a downloadable attachment. X-Row-Count carries the row count and X-Truncated is set when the 50,000-row cap was hit.

The response is of type string.