Skip to main content

List CSV downloads

GET 
/phone_numbers/csv_downloads

List CSV downloads

Request​

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

Responses​

200: Successful response with a list of CSV downloads.

Schema

    data

    object[]

  • Array [

    • id string

    Identifies the resource.

    record_type string

    Identifies the type of the resource.

    url string

    The URL at which the CSV file can be retrieved.

    status string

    Possible values: [pending, complete, failed, expired]

    Default value: pending

    Indicates the completion level of the CSV report. Only complete CSV download requests will be able to be retrieved.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta

    object

    url string

    URL with additional information on the error.

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/phone_numbers/csv_downloads' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

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