Skip to contentSkip to navigationSkip to topbar
Twilio Docs
On this page

Flow

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

Flow Properties

flow-properties page anchor
Property nameTypeRequiredDescriptionChild properties
sidSID<FW>

Optional

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>

Optional

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

Optional

Not PII

The string that you assigned to describe the Flow.

statusenum<string>

Optional

Not PII

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

Possible values:
draftpublished
versioninteger

Optional

Not PII

The latest version number of the Flow's definition.

Default: 0
date_createdstring<date-time>

Optional

Not PII

The date and time in GMT when the resource was created specified in ISO 8601(link takes you to an external page) format.

date_updatedstring<date-time>

Optional

Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601(link takes you to an external page) format.

urlstring<uri>

Optional

Not PII

The absolute URL of the resource.

linksobject<uri-map>

Optional

Not PII

The URLs of the Flow's nested resources.

Fetch a single flow

fetch-a-single-flow page anchor
GET https://studio.twilio.com/v1/Flows/{Sid}

Path parameters

path-parameters page anchor
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 FlowLink to code sample: Fetch Flow
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID and Auth Token at twilio.com/console

5
// and set the environment variables. See http://twil.io/secure

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function fetchFlow() {

11
  const flow = await client.studio.v1

12
    .flows("FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")

13
    .fetch();

14


15
  console.log(flow.sid);

16
}

17


18
fetchFlow();

Output

1
{

2
  "sid": "FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",

3
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

4
  "friendly_name": "Test Flow",

5
  "status": "published",

6
  "version": 1,

7
  "date_created": "2017-11-06T12:00:00Z",

8
  "date_updated": null,

9
  "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

10
  "links": {

11
    "engagements": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements",

12
    "executions": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions"

13
  }

14
}

Read a list of flows

read-a-list-of-flows page anchor
GET https://studio.twilio.com/v1/Flows

Query parameters

query-parameters page anchor
Property nameTypeRequiredPIIDescription
PageSizeinteger

Optional

Not PII

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

Minimum: 1Maximum: 1000
Pageinteger

Optional

Not PII

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

Minimum: 0
PageTokenstring

Optional

Not PII

The page token. This is provided by the API.

Read FlowLink to code sample: Read Flow
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID and Auth Token at twilio.com/console

5
// and set the environment variables. See http://twil.io/secure

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function listFlow() {

11
  const flows = await client.studio.v1.flows.list({ limit: 20 });

12


13
  flows.forEach((f) => console.log(f.sid));

14
}

15


16
listFlow();

Output

1
{

2
  "meta": {

3
    "previous_page_url": null,

4
    "next_page_url": null,

5
    "url": "https://studio.twilio.com/v1/Flows?PageSize=50&Page=0",

6
    "page": 0,

7
    "first_page_url": "https://studio.twilio.com/v1/Flows?PageSize=50&Page=0",

8
    "page_size": 50,

9
    "key": "flows"

10
  },

11
  "flows": []

12
}

Delete a flow

delete-a-flow page anchor
DELETE https://studio.twilio.com/v1/Flows/{Sid}

Path parameters

path-parameters-1 page anchor
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 FlowLink to code sample: Delete Flow
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID and Auth Token at twilio.com/console

5
// and set the environment variables. See http://twil.io/secure

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function deleteFlow() {

11
  await client.studio.v1.flows("FWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX").remove();

12
}

13


14
deleteFlow();

Need some help?

Terms of service
Privacy Policy

Copyright © 2024 Twilio Inc.