TaskLists: GetTaskLists

Returns the task lists associated with a room.

Permissions

Rooms Version 6: You must either be a member of the room who has been added to one or more tasks, or have one of the following permissions set to true:

  • canAddTasksToAnyTaskLists
  • canApplyTaskList
  • canRemoveAnyTaskList
  • canSubmitTaskList
  • canReviewTaskList

Note: If a room has multiple tasks lists, you only see the task lists that contain tasks to which you have been added.

Rooms Version 5: You must be room owner, a member of the room who has been added to one or more tasks, or be a Manager for whom the canManageCompanyRooms permission is set to true.

Request

HTTP request

GET /restapi/v2/accounts/{accountId}/rooms/{roomId}/task_lists

Parameters

Parameter NameValueDescription
Path Parameters
roomIdinteger

(Required) The id of the room.

accountIdstring

(Required) The id of the account.

Responses

CodeDescriptionReference
200

Task lists successfully retrieved.

TaskListSummaryList
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

TaskLists::GetTaskLists

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.

TaskListSummary

Contains information about a task list.

taskListIdinteger

The id of the task list.

namestring

The name of the task list.

taskListTemplateIdinteger

The id of the task list template.

submittedForReviewDatestring

The UTC DateTime when the task list was submitted for review.

approvalDatestring

The UTC DateTime when the task list was approved.

rejectedDatestring

The date on which the reviewer rejected the task list.

createdDatestring

The UTC date and time when the task list was created. This is a read-only value that the service assigns.

Example: 2019-07-17T17:45:42.783Z

approvedByUserIdinteger

The id of the user who approved the task list.

rejectedByUserIdinteger

The id of the user who rejected the task list.

commentstring

Contains a user comment about the task list.

TaskListSummaryList

Contains a list of task list summaries.

taskListSummaries[TaskListSummary]

A list of task list summaries.

}} />