Sign in

v1

latestOpenAPI 3.0.12026-07-135210550.0 KB
Finalize Templates

List Templates

get/finalize/v2/templates

Query parameters

pageinteger

Which page of templates to get.

per_pageinteger

How many templates should be returned per page.

string[]

Filter templates by a specific attribute. Options are:</br> filter[created_at][before] - Returns only templates created before this date. Must be in ISO8601 format.</br> filter[created_at][after] - Returns only templates created after this date. Must be in ISO8601 format.</br> filter[name] - Returns only templates with the specified name attribute. This can query name with partial match.</br> filter[kind] - Returns only templates with the specified kind attribute. Must be draft, intake or request_form.</br></br> NOTE: Query multiple kind using syntax: ?filter[kind][]=intake&filter[kind][]=draft</br>

Response

success

total_countinteger required

Total number of items returned

Example response

{
  "data": [
    {
      "id": "99fd96ed-2c61-4066-b800-c34850146ea9",
      "name": "Security Addendum",
      "description": "Security terms for vendors",
      "kind": "draft"
    }
  ],
  "total_count": 1,
  "_links": {
    "next": {
      "href": "https://api.linksquares.com/api/finalize/v2/templates?page=3&per_page=1"
    },
    "prev": {
      "href": "https://api.linksquares.com/api/finalize/v2/templates?page=1&per_page=1"
    }
  }
}