v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-056136556.2 KB
TaskrouterV1Worker

get/v1/Workspaces/{WorkspaceSid}/Workers

Path parameters

WorkspaceSidstring required

The SID of the Workspace with the Workers to read.

Query parameters

ActivityNamestring

The activity_name of the Worker resources to read.

ActivitySidstring

The activity_sid of the Worker resources to read.

Availablestring

Whether to return only Worker resources that are available or unavailable. Can be true, 1, or yes to return Worker resources that are available, and false, or any value returns the Worker resources that are not available.

FriendlyNamestring

The friendly_name of the Worker resources to read.

TargetWorkersExpressionstring

Filter by Workers that would match an expression. In addition to fields in the workers' attributes, the expression can include the following worker fields: sid, friendly_name, activity_sid, or activity_name

TaskQueueNamestring

The friendly_name of the TaskQueue that the Workers to read are eligible for.

TaskQueueSidstring

The SID of the TaskQueue that the Workers to read are eligible for.

Orderingstring

Sorting parameter for Workers

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