TaskrouterV1Task

get/v1/Workspaces/{WorkspaceSid}/Tasks

Path parameters

WorkspaceSidstring required

The SID of the Workspace with the Tasks to read.

Query parameters

Priorityinteger

The priority value of the Tasks to read. Returns the list of all Tasks in the Workspace with the specified priority.

AssignmentStatusstring[]

The assignment_status of the Tasks you want to read. Can be: pending, reserved, assigned, canceled, wrapping, or completed. Returns all Tasks in the Workspace with the specified assignment_status.

WorkflowSidstring

The SID of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this SID.

WorkflowNamestring

The friendly name of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this friendly name.

TaskQueueSidstring

The SID of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this SID.

TaskQueueNamestring

The friendly_name of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this friendly name.

EvaluateTaskAttributesstring

The attributes of the Tasks to read. Returns the Tasks that match the attributes specified in this parameter.

Orderingstring

How to order the returned Task resources. y default, Tasks are sorted by ascending DateCreated. This value is specified as: Attribute:Order, where Attribute can be either Priority or DateCreated and Order can be either asc or desc. For example, Priority:desc returns Tasks ordered in descending order of their Priority. Multiple sort orders can be specified in a comma-separated list such as Priority:desc,DateCreated:asc, which returns the Tasks in descending Priority order and ascending DateCreated Order.

HasAddonsboolean

Whether to read Tasks with addons. If true, returns only Tasks with addons. If false, returns only Tasks without addons.

PageSizeinteger

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Pageinteger

The page index. This value is simply for client state.

PageTokenstring

The page token. This is provided by the API.

Response

OK

Changes