Path parameters

• WorkspaceSid string Required

  The SID of the Workspace with the WorkerReservation resources to read.

• WorkerSid string Required

  The SID of the reserved Worker resource with the WorkerReservation resources to read.

Query parameters

• ReservationStatus string

  Returns the list of reservations for a worker with a specified ReservationStatus. Can be: pending, accepted, rejected, timeout, canceled, or rescinded.

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

• PageSize integer

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

  Minimum value is 1, maximum value is 1000.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri)
    • page integer
    • page_size integer
    • previous_page_url string(uri)
    • url string(uri)
  • reservations array[object]
    Hide reservations attributes Show reservations attributes array[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

    • links object(uri-map) | null

      The URLs of related resources

    • 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 WorkerReservation resource

    • 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 worker is contained within.

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