LIlinksquares
Finalize Agreements

List Agreements

get/finalize/v2/agreements

Request

Query parameters

pageinteger

Which page of agreements to get.

per_pageinteger

How many agreements should be returned per page.

string[]

Filter agreements by a specific attribute. Options are:</br> filter[name] - Returns only agreements with the specified name attribute. This can query name with partial match.</br> filter[created_at][before] - Returns only agreements created before this date. Must be in ISO8601 format.</br> filter[created_at][after] - Returns only agreements created after this date. Must be in ISO8601 format.</br> filter[status_updated_at][before] - Returns only agreements with status updated before this date. Must be in ISO8601 format.</br> filter[status_updated_at][after] - Returns only agreements with status updated after this date. Must be in ISO8601 format.</br> filter[status_id][] - Filter to agreements with a status_id that contains the specified value.</br> filter[template_id][] - Filter to agreements with a template_id that contains the specified value.</br> filter[analyze_agreement_id][] - Filter to agreements with an analyze_agreement_id that contains the specified value.</br></br> NOTE: Query multiple status_id or template_id using syntax: ?filter[template_id][]=4076215b-2476-467b-893d-1fe9fd9199d9&filter[template_id][]=93978d89-38a9-4d5f-b531-9468ff1ba9af</br>

Response

success

total_countinteger required

Total number of items returned

Example response

{
  "data": [
    {
      "name": "LinkSquares Contract",
      "analyze_agreement_id": "2bdb40a3-e5d3-47fb-bcb8-b5b1d6ee549d",
      "template_id": "a25771d9-f44b-4284-82a7-a9e822ae6c18",
      "owner_id": "b25771d9-f44b-4284-82a7-a9e822ae6c18"
    }
  ],
  "total_count": 1,
  "_links": {
    "next": {
      "href": "https://api.linksquares.com/api/finalize/v2/agreements?page=3&per_page=1"
    },
    "prev": {
      "href": "https://api.linksquares.com/api/finalize/v2/agreements?page=1&per_page=1"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.