List workspace

GET /v1/Workspaces

TODO: Resource-level docs

Query parameters

  • 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

  • OK

    Hide response attributes Show response attributes object
    • meta object
      Hide meta attributes Show meta attributes object
    • 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

      • The name of the default activity

      • 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

      • multi_task_enabled boolean | null

        Whether multi-tasking is enabled

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

        Values are FIFO or LIFO.

      • sid string | null

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

      • The name of the timeout activity

      • 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

GET /v1/Workspaces
curl \
 -X GET https://taskrouter.twilio.com/v1/Workspaces \
 --user "username:password"
Response examples (200)
{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "workspaces": [
    {
      "account_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "default_activity_name": "string",
      "default_activity_sid": "string",
      "event_callback_url": "https://example.com",
      "events_filter": "string",
      "friendly_name": "string",
      "links": {},
      "multi_task_enabled": true,
      "prioritize_queue_order": "FIFO",
      "sid": "string",
      "timeout_activity_name": "string",
      "timeout_activity_sid": "string",
      "url": "https://example.com"
    }
  ]
}
Response examples (200)
{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "workspaces": [
    {
      "account_sid": "string",
      "date_created": "2024-05-04T09:42:00+00:00",
      "date_updated": "2024-05-04T09:42:00+00:00",
      "default_activity_name": "string",
      "default_activity_sid": "string",
      "event_callback_url": "https://example.com",
      "events_filter": "string",
      "friendly_name": "string",
      "links": {},
      "multi_task_enabled": true,
      "prioritize_queue_order": "FIFO",
      "sid": "string",
      "timeout_activity_name": "string",
      "timeout_activity_sid": "string",
      "url": "https://example.com"
    }
  ]
}