Skip to main content

List all documents

GET 
/documents

List all documents ordered by created_at descending.

Request

Query Parameters

    filter object

    Consolidated filter parameter for documents (deepObject style). Originally: filter[filename][contains], filter[customer_reference][eq], filter[customer_reference][in][], filter[created_at][gt], filter[created_at][lt]

    sort string[]

    Possible values: [filename, created_at, updated_at, -filename, -created_at, -updated_at]

    Consolidated sort parameter for documents (deepObject style). Originally: sort[]

    page object

    Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Responses

200: Successful response

default: Unexpected error

Request samples


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

Response samples


{
"data": [
{
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": true,
"created_at": "2018-02-02T22:25:27.521Z",
"updated_at": "2018-02-02T22:25:27.521Z",
"content_type": "application/pdf",
"size": {
"unit": "bytes",
"amount": 123456
},
"status": "pending",
"sha256": "08a96c641c3a74e44eb59afb61a24f2cb9f4d7188748e76ba4bb5edfa3cb7d1c",
"filename": "test-document.pdf",
"customer_reference": "MY REF 001"
}
],
"meta": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25
}
}