CSV Downloads API

List CSV downloads

SecuritybearerAuth

Request

query Parameters

page[number]	integer >= 1 Default: 1 The page number to load
page[size]	integer [ 1 .. 250 ] Default: 20 The size of the page

Responses

200

Successful response with a list of CSV downloads.

Response Schema: application/json

	Array of objects (CsvDownload)
	object (PaginationMeta)

default

Unexpected error

Response Schema: application/json

Array of objects (Error)

Array

code required	string <int>
detail	string
meta	object
	object
title required	string

get/phone_numbers/csv_downloads

Request samples

Response samples

200
default

application/json

{"data": [{"id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
"record_type": "csv_download",
"status": "pending",
"url": "https://www.telnyx.com/sample/42587e44-3a3e-46de-9255-0c9a7a1d1ec7"
}
],
"meta": {"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}

Create a CSV download

SecuritybearerAuth

Responses

200

Successful response with details about a CSV download.

Response Schema: application/json

Array of objects (CsvDownload)

Array

id	string Identifies the resource.
record_type	string Identifies the type of the resource.
status	string Default: "pending" Indicates the completion level of the CSV report. Only complete CSV download requests will be able to be retrieved. Enum: "pending" "complete" "failed" "expired"
url	string The URL at which the CSV file can be retrieved.

default

Unexpected error

Response Schema: application/json

Array of objects (Error)

Array

code required	string <int>
detail	string
meta	object
	object
title required	string

post/phone_numbers/csv_downloads

Request samples

Response samples

200
default

application/json

{"data": [{"id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
"record_type": "csv_download",
"status": "pending",
"url": "https://www.telnyx.com/sample/42587e44-3a3e-46de-9255-0c9a7a1d1ec7"
}
]
}

Retrieve a CSV download

SecuritybearerAuth

Request

path Parameters

id

required

string

Identifies the CSV download.

Responses

200

Successful response with details about a CSV download.

Response Schema: application/json

Array of objects (CsvDownload)

Array

id	string Identifies the resource.
record_type	string Identifies the type of the resource.
status	string Default: "pending" Indicates the completion level of the CSV report. Only complete CSV download requests will be able to be retrieved. Enum: "pending" "complete" "failed" "expired"
url	string The URL at which the CSV file can be retrieved.

default

Unexpected error

Response Schema: application/json

Array of objects (Error)

Array

code required	string <int>
detail	string
meta	object
	object
title required	string

get/phone_numbers/csv_downloads/{id}

Request samples

Response samples

200
default

application/json

{"data": [{"id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
"record_type": "csv_download",
"status": "pending",
"url": "https://www.telnyx.com/sample/42587e44-3a3e-46de-9255-0c9a7a1d1ec7"
}
]
}