Fetch task reservation

GET /v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations/{Sid}

Tasks reserved for workers

Path parameters

  • WorkspaceSid string Required

    The SID of the Workspace with the TaskReservation resource to fetch.

  • TaskSid string Required

    The SID of the reserved Task resource with the TaskReservation resource to fetch.

  • Sid string Required

    The SID of the TaskReservation resource to fetch.

Responses

  • OK

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • date_created string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was last updated

    • reservation_status string | null

      The current status of the reservation

      Values are pending, accepted, rejected, timeout, canceled, rescinded, wrapping, or completed.

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WR[0-9a-fA-F]{32}$.

    • task_sid string | null

      The SID of the reserved Task resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WT[0-9a-fA-F]{32}$.

    • url string(uri) | null

      The absolute URL of the TaskReservation reservation

    • worker_name string | null

      The friendly_name of the Worker that is reserved

    • worker_sid string | null

      The SID of the reserved Worker resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WK[0-9a-fA-F]{32}$.

    • workspace_sid string | null

      The SID of the Workspace that this task is contained within.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.

GET /v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations/{Sid}
curl \
 -X GET https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations/{Sid} \
 --user "username:password"
Response examples (200)
{
  "account_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "links": {},
  "reservation_status": "pending",
  "sid": "string",
  "task_sid": "string",
  "url": "https://example.com",
  "worker_name": "string",
  "worker_sid": "string",
  "workspace_sid": "string"
}
Response examples (200)
{
  "account_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "links": {},
  "reservation_status": "pending",
  "sid": "string",
  "task_sid": "string",
  "url": "https://example.com",
  "worker_name": "string",
  "worker_sid": "string",
  "workspace_sid": "string"
}