Sign in

v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Tasks

Return the data for all Tasks

Outlines the parameters, optional and required, used when requesting the data for all Tasks

get/tasks.json

Query parameters

assignee_idinteger

The unique identifier for a single User or Contact. Use the keyword null to match those without a Task. The list will be filtered to include only the Task records with the matching property.

assignee_type'user' | 'contact'

Filter Task records to those with a specific assignee. Must be passed if filtering by assignee.

assigner_idinteger

The unique identifier for a single User. Use the keyword null to match those without a Task. The list will be filtered to include only the Task records with the matching property.

cascading_source_idinteger

Filter Task records to those with a parent task that has the specified ID.

client_idinteger

The unique identifier for a single Contact. Use the keyword null to match those without a Task. The list will be filtered to include only the Task records with the matching property.

completeboolean

Filter Task records to those which are complete or not.

created_sincestring date-time

Filter Task records to those having the created_at field after a specific time. (Expects an ISO-8601 timestamp).

due_at_fromstring date

Start of date range when querying by due_at in a range. (Expects an ISO-8601 date).

due_at_presentboolean

Filter Task records to those that have a due date specified, or not.

due_at_tostring date

End of date range when querying by due_at in a range. (Expects an ISO-8601 date).

fieldsstring

The fields to be returned. See response samples for what fields are available. For more information see the fields section.

ids[]integer

Filter Task records to those having the specified unique identifiers.

limitinteger

A limit on the number of Task records to be returned. Limit can range between 1 and 200. Default: 200.

matter_idinteger

The unique identifier for a single Matter. Use the keyword null to match those without a Task. The list will be filtered to include only the Task records with the matching property.

order'name(asc)' | 'name(desc)' | 'task_type.name(asc)' | 'task_type.name(desc)' | 'id(asc)' | 'id(desc)' | 'priority(asc)' | 'priority(desc)' | 'matter.display_number(asc)' | 'matter.display_number(desc)' | 'due_at(asc)' | 'due_at(desc)' | 'due_at_strict(asc)' | 'due_at_strict(desc)' | 'completed_at(asc)' | 'completed_at(desc)'

Orders the Task records by the given field. Default: id(asc).

page_tokenstring

A token specifying which page to return.

permission'private' | 'public'

Filter Task records to those with the given permission. Returns all tasks by default.

priority'high' | 'normal' | 'low'

Filter Task records to those with the given priority.

querystring

Wildcard search for name or description matching a given string.

responsible_attorney_idinteger

Filter Task records to those that have an associated matter with a responsible attorney ID.

status'pending' | 'in_progress' | 'in_review' | 'complete' | 'draft'

Filter Task records to those with the given status. Users without advanced tasks enabled may only specify 'complete' or 'pending'.

statuses[]'pending' | 'in_progress' | 'in_review' | 'complete' | 'draft'

Filter Task records to those with the given statuses. Users without advanced tasks enabled may only specify 'complete' or 'pending'.

statute_of_limitationsboolean

Filter Task records to those which are a statute of limitations or not.

task_type_idinteger

The unique identifier for a single TaskType. Use the keyword null to match those without a Task. The list will be filtered to include only the Task records with the matching property.

time_entries_presentboolean

Filter Task records to those that have associated time entries, or not.

updated_sincestring date-time

Filter Task records to those having the updated_at field after a specific time. (Expects an ISO-8601 timestamp).

Headers

X-API-VERSIONstring

The API minor version. Default: latest version.

Response

Ok