TaskrouterWorker Reservation
List Worker Reservation
Authorization
accountSid_authToken AuthorizationBasic <token>
In: header
Path Parameters
WorkspaceSid*string
The SID of the Workspace with the WorkerReservation resources to read.
Match
^WS[0-9a-fA-F]{32}$Length
34 <= length <= 34WorkerSid*string
The SID of the reserved Worker resource with the WorkerReservation resources to read.
Match
^WK[0-9a-fA-F]{32}$Length
34 <= length <= 34Query Parameters
ReservationStatus?WorkerReservationStatus
Returns the list of reservations for a worker with a specified ReservationStatus. Can be: pending, accepted, rejected, timeout, canceled, or rescinded.
Value in
- "pending"
- "accepted"
- "rejected"
- "timeout"
- "canceled"
- "rescinded"
- "wrapping"
- "completed"
PageSize?integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Format
int64Range
1 <= value <= 1000Page?integer
The page index. This value is simply for client state.
Range
0 <= valuePageToken?string
The page token. This is provided by the API.
Response Body
application/json
curl -X GET "https://example.com/v1/Workspaces/stringstringstringstringstringstri/Workers/stringstringstringstringstringstri/Reservations"{ "meta": { "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0", "key": "reservations", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations?PageSize=50&Page=0" }, "reservations": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2014-05-14T10:50:02Z", "date_updated": "2014-05-15T16:03:42Z", "links": { "task": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "worker": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "reservation_status": "accepted", "sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Reservations/WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "worker_name": "Doug", "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ]}