Query parameters

• FriendlyName string

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

• 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

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

    • account_sid string | null

      The SID of the Account that created the Workspace 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.

    • 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. If provided, the Workspace will publish events to this URL, for example, to collect data for reporting. See Workspace Events for more information. This parameter supports Twilio's Webhooks (HTTP callbacks) Connection Overrides.

    • events_filter string | null

      The list of Workspace events for which to call event_callback_url. For example, if EventsFilter=task.created, task.canceled, worker.activity.update, then TaskRouter will call event_callback_url only when a task is created, canceled, or a Worker activity is updated.

    • friendly_name string | null

      The string that you assigned to describe the Workspace resource. For example Customer Support or 2014 Election Campaign.

    • multi_task_enabled boolean | null

      Whether multi-tasking is enabled. The default is true, which enables multi-tasking. Multi-tasking allows Workers to handle multiple Tasks simultaneously. When enabled (true), each Worker can receive parallel reservations up to the per-channel maximums defined in the Workers section. In single-tasking each Worker would only receive a new reservation when the previous task is completed. Learn more at Multitasking.

    • sid string | null

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

    • prioritize_queue_order string

      The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues. Can be: LIFO or FIFO and the default is FIFO. For more information, see Queue Ordering.

      Values are FIFO or LIFO.

    • url string(uri) | null

      The absolute URL of the Workspace resource.

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