Sign in

v1

latestOpenAPI 3.0.12026-07-135210550.0 KB
Finalize Tasks

List Tasks

get/finalize/v2/tasks

Query parameters

pageinteger

Which page of tasks to get.

per_pageinteger

How many tasks should be returned per page.

string[]

Filter tasks by a specific attribute. Options are:</br> filter[name] - Returns only tasks with the specified name attribute. This can query name with partial match.</br> filter[active] - Returns either active or inactive tasks. Options are: true or false.</br> filter[status][] - Returns only tasks with the specified statuses. Options are: unreviewed, approved, rejected</br> filter[agreement_id][] - Returns only tasks that belong to an agreement with the specified agreement UUIDs.</br> filter[author_id][] - Returns only tasks that have an author with the specified user UUIDs.</br> filter[assignee_ids][] - Returns only tasks assigned to the specified user UUIDs. Includes tasks with additional assignee UUIDs besides those specified.</br> NOTE: Query multiple agreement_id or author_id using syntax: ?filter[agreement_id][]=4076215b-2476-467b-893d-1fe9fd9199d9&filter[agreement_id][]=93978d89-38a9-4d5f-b531-9468ff1ba9af</br>

Response

success

total_countinteger required

Total number of items returned

Example response

{
  "data": [
    {
      "created_at": "2023-08-15T20:00:39Z",
      "due_date": "2023-09-15T20:00:39Z",
      "name": "Approve Deliverable",
      "text": "Please review the latest version and approve the agreement to complete this task"
    }
  ],
  "total_count": 1,
  "_links": {
    "next": {
      "href": "https://api.linksquares.com/api/finalize/v2/tasks?page=3&per_page=1"
    },
    "prev": {
      "href": "https://api.linksquares.com/api/finalize/v2/tasks?page=1&per_page=1"
    }
  }
}