Path parameters

• WorkspaceSid string Required

  The SID of the Workspace with the Workers to read.

Query parameters

• ActivityName string

  The activity_name of the Worker resources to read.

• ActivitySid string

  The activity_sid of the Worker resources to read.

• Available string

  Whether to return only Worker resources that are available or unavailable. Can be true, 1, or yes to return Worker resources that are available, and false, or any value returns the Worker resources that are not available.

• FriendlyName string

  The friendly_name of the Worker resources to read.

• TargetWorkersExpression string

  Filter by Workers that would match an expression on a TaskQueue. This is helpful for debugging which Workers would match a potential queue.

• TaskQueueName string

  The friendly_name of the TaskQueue that the Workers to read are eligible for.

• TaskQueueSid string

  The SID of the TaskQueue that the Workers to read are eligible for.

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

    • activity_name string | null

      The friendly_name of the Worker's current Activity

    • activity_sid string | null

      The SID of the Worker's current Activity

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

    • attributes string | null

      The JSON string that describes the Worker

    • available boolean | null

      Whether the Worker is available to perform tasks

    • date_created string(date-time) | null

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

    • date_status_changed string(date-time) | null

      The date and time in GMT of the last change to the Worker's activity

    • date_updated string(date-time) | null

      The ISO 8601 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

    • sid string | null

      The unique string that identifies the resource

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

    • url string(uri) | null

      The absolute URL of the Worker resource

    • workspace_sid string | null

      The SID of the Workspace that contains the Worker

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