Sign in

v1

latestOpenAPI 3.0.12026-07-135210550.0 KB
Finalize Attachments

List Agreement Attachments

get/finalize/v2/agreements/{agreement_id}/attachments

Path parameters

agreement_idstring uuid required

The UUID of the agreement record.

Query parameters

pageinteger

Which page of attachments to get.

per_pageinteger

How many attachments should be returned per page.

Response

success

total_countinteger required

Total number of items returned

Example response

{
  "data": [
    {
      "file_name": "ImportantSpreadsheet.xlsx"
    }
  ],
  "total_count": 1,
  "_links": {
    "next": {
      "href": "https://api.linksquares.com/api/finalize/v2/agreements/894e86b8-2866-494e-bb16-5aa19fce3348/attachments?page=3&per_page=1"
    },
    "prev": {
      "href": "https://api.linksquares.com/api/finalize/v2/agreements/894e86b8-2866-494e-bb16-5aa19fce3348/attachments?page=1&per_page=1"
    }
  }
}