Path parameters

• WorkspaceSid string Required

  The SID of the Workspace with the TaskQueue to read.

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

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.

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

• Ordering string

  Sorting parameter for TaskQueues

• 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

  • 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

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

    • account_sid string | null

      The SID of the Account that created the TaskQueue resource.

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

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

    • assignment_activity_name string | null

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

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • friendly_name string | null

      The string that you assigned to describe the resource.

    • max_reserved_workers integer

      The maximum number of Workers to reserve for the assignment of a task in the queue. Can be an integer between 1 and 50, inclusive and defaults to 1.

      Default value is 0.

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

    • reservation_activity_name string | null

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

    • sid string | null

      The unique string that we created to identify the TaskQueue 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. For example '"language" == "spanish"' If no TargetWorkers parameter is provided, Tasks will wait in the TaskQueue until they are either deleted or moved to another TaskQueue. Additional examples on how to describing Worker selection criteria below. Defaults to 1==1.

    • task_order string

      How Tasks will be assigned to Workers. Set this parameter to LIFO to assign most recently created Task first or FIFO to assign the oldest Task. Default is FIFO. Click here to learn more.

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

    • 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)