List all attachments

GET /v2/attachments

Query parameters

  • transaction_id string(uuid)

    Filter attachments by transaction.

  • When set to true, results will include attachments that have been deleted.

    Default value is false.

  • page integer(int32)

    Index of the requested page.

    Minimum value is 1. Default value is 1.

  • size integer(int32)

    Number of elements per page in response.

    Minimum value is 1, maximum value is 100. Default value is 10.


  • 200 application/json


    Hide response attributes Show response attributes object
    • results array[object] Required

      Elements of the page.

      Hide results attributes Show results attributes object
      • id string(uuid) Required

        ID of the attachment.

      • transaction_id string(uuid) Required

        ID of the transaction this document is attached to.

      • filename string Required

        Name of the attached file.

      • size integer(int64) Required

        Size of the attached file in bytes.

      • mime_type string Required

        Mime type of the attached file.

      • date string(date-time) Required

        Date at which the file has been attached to a transaction.

      • is_deleted boolean Required

        Whether or not this attachment has been deleted.

    • has_prev boolean Required

      Flag indicating if there is a previous page.

    • has_next boolean Required

      Flag indicating if there is a next page.

GET /v2/attachments
curl \
 -X GET \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
  "results": [
      "id": "db2b50c0-a943-4eb1-a69f-fa37f112daa8",
      "transaction_id": "20588f37-0ca6-4abd-80ae-1964d601b516",
      "filename": "document.pdf",
      "size": 42,
      "mime_type": "application/pdf",
      "date": "2024-05-04T09:42:00+00:00",
      "is_deleted": true
  "has_prev": true,
  "has_next": true