Flow

Flows are individual workflows that you create. They can handle one or more use cases.

Flow Properties

Property nameTypePIIDescription

sidSID<FW>

Not PII

The unique string that we created to identify the Flow resource.

Pattern: ^FW[0-9a-fA-F]{32}$Min length: 34Max length: 34

account_sidSID<AC>

Not PII

The SID of the Account that created the Flow resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

friendly_namestring

Not PII

The string that you assigned to describe the Flow.

statusenum<string>

Not PII

The status of the Flow. Can be: draft or published.

Possible values:

draftpublished

versioninteger

Not PII

The latest version number of the Flow's definition.

date_createdstring<date-time>

Not PII

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updatedstring<date-time>

Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

urlstring<uri>

Not PII

The absolute URL of the resource.

linksobject<uri-map>

Not PII

The URLs of the Flow's nested resources.

Fetch a single flow

GET https://studio.twilio.com/v1/Flows/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<FW>required

Not PII

The SID of the Flow resource to fetch.

Pattern: ^FW[0-9a-fA-F]{32}$Min length: 34Max length: 34

Fetch Flow

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18
_18async function fetchFlow() {
_18  const flow = await client.studio.v1
_18    .flows("FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_18    .fetch();
_18
_18  console.log(flow.sid);
_18}
_18
_18fetchFlow();

Output


_14{
_14  "sid": "FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14  "friendly_name": "Test Flow",
_14  "status": "published",
_14  "version": 1,
_14  "date_created": "2017-11-06T12:00:00Z",
_14  "date_updated": null,
_14  "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14  "links": {
_14    "engagements": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements",
_14    "executions": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions"
_14  }
_14}

Read a list of flows

GET https://studio.twilio.com/v1/Flows

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeintegerOptional

Not PII

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

PageintegerOptional

Not PII

The page index. This value is simply for client state.

Minimum: 0

PageTokenstringOptional

Not PII

The page token. This is provided by the API.

Read Flow

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_16// Download the helper library from https://www.twilio.com/docs/node/install
_16const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_16
_16// Find your Account SID and Auth Token at twilio.com/console
_16// and set the environment variables. See http://twil.io/secure
_16const accountSid = process.env.TWILIO_ACCOUNT_SID;
_16const authToken = process.env.TWILIO_AUTH_TOKEN;
_16const client = twilio(accountSid, authToken);
_16
_16async function listFlow() {
_16  const flows = await client.studio.v1.flows.list({ limit: 20 });
_16
_16  flows.forEach((f) => console.log(f.sid));
_16}
_16
_16listFlow();

Output


_12{
_12  "meta": {
_12    "previous_page_url": null,
_12    "next_page_url": null,
_12    "url": "https://studio.twilio.com/v1/Flows?PageSize=50&Page=0",
_12    "page": 0,
_12    "first_page_url": "https://studio.twilio.com/v1/Flows?PageSize=50&Page=0",
_12    "page_size": 50,
_12    "key": "flows"
_12  },
_12  "flows": []
_12}

Delete a flow

DELETE https://studio.twilio.com/v1/Flows/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<FW>required

Not PII

The SID of the Flow resource to delete.

Pattern: ^FW[0-9a-fA-F]{32}$Min length: 34Max length: 34

Delete Flow

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_14// Download the helper library from https://www.twilio.com/docs/node/install
_14const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_14
_14// Find your Account SID and Auth Token at twilio.com/console
_14// and set the environment variables. See http://twil.io/secure
_14const accountSid = process.env.TWILIO_ACCOUNT_SID;
_14const authToken = process.env.TWILIO_AUTH_TOKEN;
_14const client = twilio(accountSid, authToken);
_14
_14async function deleteFlow() {
_14  await client.studio.v1.flows("FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX").remove();
_14}
_14
_14deleteFlow();