List Worker
GET {{twilio_taskrouter}}/v1/Workspaces/:WorkspaceSid/Workers?ActivityName=et ad si&ActivitySid=WAb1fFbf6cE4cdE1Ad1aA9599A7DEBbaCA&Available=et ad si&FriendlyName=et ad si&TargetWorkersExpression=et ad si&TaskQueueName=et ad si&TaskQueueSid=WQ4A1f8Bcc18BebCc596Dc37ACCef0641F&Ordering=et ad si&PageSize=153
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
ActivityName | string | The activity_name of the Worker resources to read. | |
ActivitySid | string | The activity_sid of the Worker resources to read. | |
Available | string | 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. | |
FriendlyName | string | The friendly_name of the Worker resources to read. | |
TargetWorkersExpression | string | Filter by Workers that would match an expression on a TaskQueue. This is helpful for debugging which Workers would match a potential queue. | |
TaskQueueName | string | The friendly_name of the TaskQueue that the Workers to read are eligible for. | |
TaskQueueSid | string | The SID of the TaskQueue that the Workers to read are eligible for. | |
Ordering | string | Sorting parameter for Workers | |
PageSize | number | How many resources to return in each list page. The default is 50, and the maximum is 1000. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"workers":[{"account_sid":"ACb14fEFD4e8DC84Cc1fad5C71EeBaeE3F","activity_name":"veniam","activity_sid":"WABDaf32926DB31c18188ED4AbcccC72bD","attributes":"consequat fugiat eu aute","available":false,"date_created":"1978-02-27T14:59:45.607Z","date_status_changed":"1981-01-24T21:57:20.694Z","date_updated":"1973-10-23T20:27:30.108Z","friendly_name":"deserunt nulla pariatur","sid":"WKf578f97205f6A4aeD6C4fbfadCdDd356","workspace_sid":"WS8b5ED6be9881a7F91DCCcb3294D4a2A9","url":"https://IMDStvJQhEcJhubHlRqIgpaaiDys.lskUxiwX2UThL.ILmC","links":{}},{"account_sid":"ACDb0fd1AbC5f044E371AD3bF46322E198","activity_name":"ut Ut id ut","activity_sid":"WAC47Ffadb8BeDea2816b9ea7E6E7cCcBC","attributes":"ea amet magna sint","available":true,"date_created":"1975-09-07T01:37:01.244Z","date_status_changed":"1960-01-16T07:38:34.230Z","date_updated":"1955-06-28T21:00:36.893Z","friendly_name":"laborum anim officia adipisicing labore","sid":"WKB41Bba96cEb271DCc3e42Dbf379ad38B","workspace_sid":"WSC80ba5cD2ED17eFAfA25F7eeFc1C88f0","url":"https://avtCqrsesFWgcm.nbzBmohnY5la,-HusRDkLIlNK9qmTrypC2LW0Gyx5","links":{}}],"meta":{"first_page_url":"http://nZiECGzitIsg.uvdkYfhILiUz,wjrowaeFOCuRP3e-EEscAG3gaF8AQZri3VIY2pU0KEIdtEVb","next_page_url":"https://fdqRZkZRXHbAAciFiBgiWZaAulio.zyngwOaF","page":-87077718,"page_size":-16363607,"previous_page_url":"https://cexYQreGhPhLkhHRKKZFPZmgARvyKq.mthhfH,A,0tcYQzamPIBeIaug","url":"http://nnSq.ukhqRzWnTDa,uwiwjwKr.Ja+oz7IhKpf2kDEWVkEWIoC","key":"cupidatat culpa proident"}}