Get Task List

Retrieves a list of tasks based on the provided query string

GET https://my.mattero.com.au/public/api/v1/tasks

Parameters

Name Location Type Description
search Query string:optional General search to filter tasks by
sortBy Query string:optional The property name to sort by
sortDirection Query string:optional The direction to sort the results by, expected values are [Ascending | Descending]
pageIndex Query number:optional The index of the page to resolve, page numbers start at 0
pageSize Query number:optional The maximum number of results to include on a single page, must be between or equal to 1 and 250.
pageIndexForId Query number:optional The resolves the page index for the entity with the associated id
dueDateStart Query Date:optional The starting range the Due Date must fall above
dueDateEnd Query Date:optional The ending range the Due Date must fall below
status Query string[]:optional A list of statuses to filter by, expected values are [Todo | InProgress | Done]
priority Query string[]:optional A list of priorities to filter by, expected values are [Low | Normal | High]
taskType Query string:optional The type the task is, expected values are [Matter | Contact]
my Query boolean:optional Whether the Task belongs to the authenicated user
assignedToId Query string:optional Who the task is assigned to
associatedMatterId Query string:optional The matter the task is associated with
associatedContactId Query string:optional The contact the task is associated with

Response

{
  "totalRecords": 2,
  "pageIndex": 0,
  "records": [
      {
        "id": "7752-A",
        "description": "Ring client to confirm details",
        "status": "InProgress",
        "priority": "Normal",
        "dueDate": "2022-05-18",
        "associatedContact": {
            "id": "66-A",
            "name": "Green, James"
        },
        "assignedTo": {
            "id": "772-A",
            "name": "Laksono A"
        }
      },
      {
        "id": "8742-A",
        "description": "Review court documents",
        "status": "InProgress",
        "priority": "Normal",
        "dueDate": "2022-05-18",
        "associatedMatter": {
            "number": "18",
            "title": "Jones v. White SAMPLE",
            "id": "5411-A",
            "name": "18 - Jones v. White SAMPLE"
        },
        "assignedTo": {
            "id": "772-A",
            "name": "Laksono A"
        }
      }
  ]
}

TaskListResponse object

Name Type Description
totalRecords integer The total records found on the server that match the query parameters.
pageIndex integer The index of the page found.
records Task[] An array of tasks found in the request.

Task object

Name Type Description
id string The unique identifier associated with a Task.
description string A descriptor or name used to describe or identify a Task.
status string The status of a Task, expected values are [Todo | InProgress | Done]
priority string The priority of a Task, expected values are [Low | Normal | High]
dueDate Date The date a task is due.
associatedContact EntityReference The unique identifier of a contact associated with the Task.
associatedMatter MatterReference The unique identifier of a matter associated with the Task.
assignedTo EntityReference The unique identifier of a user contact assigned to the Task.

EntityReference object

Name Type Description
id string The unique identifier of the entity.
name string The name associated with the entity.

MatterReference object

Name Type Description
id string The unique identifier of the matter.
name string The name associated with the matter.
number string The number for the associated matter.
title string The title of the referenced matter.

Status Codes

Code Summary Description
200 Ok The request was successful with a body in the response.
204 Ok The request was successful without a body in the response.
400 Bad Request The request failed validation checks.
401 Unauthorized Failed authentication check.
403 Forbidden Failed authorization check.