TaskListTemplates: GetTaskListTemplates

Returns all task list templates associated with the active user's company.

Permissions

Anyone with a valid access token can call this method.

Request

HTTP request

GET /restapi/v2/accounts/{accountId}/task_list_templates

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

(Required) The id of the account.

Optional Query Parameters
startPositioninteger

(Optional) The starting zero-based index position from which to start returning values. The default is 0.

countinteger

(Optional) The number of results to return. This value must be a number between 1 and 100 (default).

Responses

CodeDescriptionReference
200

Successfully returned list of task list templates.

TaskListTemplateList
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

TaskLists::GetTaskListTemplates

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

TaskListTemplate

Contains details about a task list template.

taskListTemplateIdinteger

The id of the task list template.

namestring

The name of the task list template.

taskCountinteger

The total number of tasks in the task list template.

tasksWithDocumentsCountinteger

The number of tasks in the task list template that have documents associated with them.

TaskListTemplateList

Contains a list of task list templates.

taskListTemplates[TaskListTemplate]

A list of task list templates.

resultSetSizeinteger

The number of results returned in this response.

startPositioninteger

The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is 0.

endPositioninteger

The last zero-based index position in the result set.

nextUristring

The URI for the next chunk of records based on the search request. This property is null for the last set of search results.

priorUristring

The URI for the previous chunk of records based on the search request. This property is null for the first set of search results.

}} />