Retrieve a list of all Flows

GET /v2/Flows

Studio flows

Retrieve a list of all Flows.

Query parameters

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

      • commit_message string | null

        Description of change made in the revision

      • 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

      • definition

        JSON representation of flow definition

      • errors array | null

        List of error in the flow definition

      • friendly_name string | null

        The string that you assigned to describe the Flow

      • links object(uri-map) | null

        Nested resource URLs

      • revision integer | null

        The latest revision number of the Flow's definition

      • sid string | null

        The unique string that identifies the resource

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

      • status string | null

        The status of the Flow

        Values are draft or published.

      • url string(uri) | null

        The absolute URL of the resource

      • valid boolean | null

        Boolean if the flow definition is valid

      • warnings array | null

        List of warnings in the flow definition

      • webhook_url string(uri) | null
    • meta object
      Hide meta attributes Show meta attributes object
GET /v2/Flows 
curl \
 -X GET https://studio.twilio.com/v2/Flows \
 --user "username:password"
Response examples (200) 
{
  "flows": [
    {
      "account_sid": "string",
      "commit_message": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "errors": [],
      "friendly_name": "string",
      "links": {},
      "revision": 42,
      "sid": "string",
      "status": "draft",
      "url": "https://example.com",
      "valid": true,
      "warnings": [],
      "webhook_url": "https://example.com"
    }
  ],
  "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"
  }
}
Response examples (200) 
{
  "flows": [
    {
      "account_sid": "string",
      "commit_message": "string",
      "date_created": "2024-05-04T09:42:00+00:00",
      "date_updated": "2024-05-04T09:42:00+00:00",
      "errors": [],
      "friendly_name": "string",
      "links": {},
      "revision": 42,
      "sid": "string",
      "status": "draft",
      "url": "https://example.com",
      "valid": true,
      "warnings": [],
      "webhook_url": "https://example.com"
    }
  ],
  "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"
  }
}