Path parameters

• WorkspaceSid string Required

  The SID of the Workspace with the TaskQueue to read.

Query parameters

• FriendlyName string

  The friendly_name of the TaskQueue resources to read.

• EvaluateWorkerAttributes string

  The attributes of the Workers to read. Returns the TaskQueues with Workers that match the attributes specified in this parameter.

• WorkerSid string

  The SID of the Worker with the TaskQueue resources to read.

• 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)
  • task_queues array[object]
    Hide task_queues attributes Show task_queues 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}$.

    • assignment_activity_name string | null

      The name of the Activity to assign Workers when a task is assigned for them

    • assignment_activity_sid string | null

      The SID of the Activity to assign Workers when a task is assigned for them

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

    • date_created string(date-time) | null

      The RFC 2822 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The RFC 2822 date and time in GMT when the resource was last updated

    • friendly_name string | null

      The string that you assigned to describe the resource

    • links object(uri-map) | null

      The URLs of related resources

    • max_reserved_workers integer | null

      The maximum number of Workers to reserve

    • reservation_activity_name string | null

      The name of the Activity to assign Workers once a task is reserved for them

    • reservation_activity_sid string | null

      The SID of the Activity to assign Workers once a task is reserved for them

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

    • sid string | null

      The unique string that identifies the resource

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

    • target_workers string | null

      A string describing the Worker selection criteria for any Tasks that enter the TaskQueue

    • task_order string | null

      How Tasks will be assigned to Workers

      Values are FIFO or LIFO.

    • url string(uri) | null

      The absolute URL of the TaskQueue resource

    • workspace_sid string | null

      The SID of the Workspace that contains the TaskQueue

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