Skip to main content

List all documents

GET 
/documents

List all documents ordered by created_at descending.

Request ​

Query Parameters

    filter[filename][contains] string

    Filter by string matching part of filename.

    filter[customer_reference][eq] string

    Filter documents by a customer references.

    filter[customer_reference][in][] string

    Filter documents by a list of customer references.

    filter[created_at][gt] string

    Filter by created at greater than provided value.

    filter[created_at][lt] string

    Filter by created at less than provided value.

    sort[] string

    Possible values: [filename, created_at, updated_at]

    Specifies the sort order for results. If you want to sort by a field in ascending order, include it as a sort parameter. If you want to sort in descending order, prepend a - in front of the field name.

    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

Schema

    data object[]

    meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code intrequired
    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

  • ]

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
  }
}