Documents

List all documents

Changed on

List all documents ordered by created_at descending.

get/documents

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/documents
  • Auth: HTTP bearer

Query parameters

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]

{
  "filename": {
    "contains": "invoice"
  },
  "customer_reference": {
    "in": [
      "REF001",
      "REF002"
    ]
  },
  "created_at": {
    "gt": "2021-01-01T00:00:00Z"
  }
}
sortstring[]

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.

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

[
  "filename"
]
sizeinteger

The size of the page

numberinteger

The page number to load

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

Response

Successful response

Example response

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "document",
      "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",
      "av_scan_status": "scanned"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status