List flex flow

GET /v1/FlexFlows

Flex Flow

Query parameters

FriendlyName string

The friendly_name of the Flex Flow resources to read.
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
- flex_flows array[object]
  
  Hide flex_flows attributes Show flex_flows attributes
  
  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}$.
  
  channel_type string | null
  
  The channel type
  
  Values are web, sms, facebook, whatsapp, line, or custom.
  
  chat_service_sid string | null
  
  The SID of the chat service
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.
  
  contact_identity string | null
  
  The channel contact's Identity
  
  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
  
  enabled boolean | null
  
  Whether the Flex Flow is enabled
  
  friendly_name string | null
  
  The string that you assigned to describe the resource
  
  integration
  
  An object that contains specific parameters for the integration
  
  integration_type string | null
  
  The software that will handle inbound messages.
  
  Values are studio, external, or task.
  
  janitor_enabled boolean | null
  
  Remove active Proxy sessions if the corresponding Task is deleted.
  
  long_lived boolean | null
  
  Re-use this chat channel for future interactions with a contact
  
  sid string | null
  
  The unique string that identifies the resource
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FO[0-9a-fA-F]{32}$.
  
  url string(uri) | null
  
  The absolute URL of the Flex Flow resource
- meta object
  
  Hide meta attributes Show meta attributes
  
  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)

GET /v1/FlexFlows

curl \
 -X GET https://flex-api.twilio.com/v1/FlexFlows \
 --user "username:password"

Response examples (200)

{
  "flex_flows": [
    {
      "account_sid": "string",
      "channel_type": "web",
      "chat_service_sid": "string",
      "contact_identity": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "enabled": true,
      "friendly_name": "string",
      "integration_type": "studio",
      "janitor_enabled": true,
      "long_lived": true,
      "sid": "string",
      "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"
  }
}