Path parameters

• WorkspaceSid string Required

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

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

• TaskSid string Required

  The SID of the reserved Task resource with the TaskReservation resources to read.

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

Query parameters

• ReservationStatus string

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

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

• WorkerSid string

  The SID of the reserved Worker resource to read.

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

• PageSize integer(int64)

  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.

• Page integer

  The page index. This value is simply for client state.

  Minimum value is 0.

• PageToken string

  The page token. This is provided by the API.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • ETag string
  • X-Rate-Limit-Limit string
  • X-Rate-Limit-Remaining string
  • X-Rate-Limit-Config string
  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • reservations array[object]
    Hide reservations attributes Show reservations attributes object

    • account_sid string | null

      The SID of the Account that created the TaskReservation 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 date and time in GMT when the resource was created specified in ISO 8601 format.

    • date_updated string(date-time) | null

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

    • reservation_status string

      The current status of the reservation. Can be: pending, accepted, rejected, or timeout.

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

    • sid string | null

      The unique string that we created to identify the TaskReservation 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}$.

    • 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}$.

    • url string(uri) | null

      The absolute URL of the TaskReservation reservation.

    • links object(uri-map) | null

      The URLs of related resources.

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri) | null
    • page integer
    • page_size integer
    • previous_page_url string(uri) | null
    • url string(uri)