Query parameters

• FriendlyName string

  The friendly_name of the Workspace resources to read. For example Customer Support or 2014 Election Campaign.

• 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)
  • workspaces array[object]
    Hide workspaces attributes Show workspaces 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

    • default_activity_name string | null

      The name of the default activity

    • default_activity_sid string | null

      The SID of the Activity that will be used when new Workers are created in the Workspace

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

    • event_callback_url string(uri) | null

      The URL we call when an event occurs

    • events_filter string | null

      The list of Workspace events for which to call event_callback_url

    • friendly_name string | null

      The string that you assigned to describe the Workspace resource

    • links object(uri-map) | null

      The URLs of related resources

    • multi_task_enabled boolean | null

      Whether multi-tasking is enabled

    • prioritize_queue_order string | null

      The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues

      Values are FIFO or LIFO.

    • sid null | string

      The unique string that identifies the resource

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

    • timeout_activity_name string | null

      The name of the timeout activity

    • timeout_activity_sid string | null

      The SID of the Activity that will be assigned to a Worker when a Task reservation times out without a response

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

    • url string(uri) | null

      The absolute URL of the Workspace resource