List flow triggers

Lists the flow triggers of the account. A flow trigger assigns a published flow to a resource, for example a phone number, for a given intention.

Typical uses:

  • Numbers assigned to a flow: filter by flow_id and resource_type=number.
  • Before deleting a flow: filter by flow_id only. A flow with triggers of any resource type cannot be deleted.
  • Flow used by a number: filter by resource_type=number and resource_id.

flow_id is the id returned by GET /flows, not a flow version id. resource_id is the id of the number, not its phone number.

The response is paged. To check whether any trigger matches, use per_page=1 and read total. To list all of them, fetch pages until _links.next is absent.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

flow-triggers:read

Query Params
string
length between 1 and 64

Filter Flow Triggers by id (exact match).

string
length between 1 and 64

Filter Flow Triggers by flow id (exact match), as returned by GET /flows, not a flow version id.

string
length between 1 and 64

Filter Flow Triggers by resource type (exact match): number (intention voice_inbound), inbound_voice_flow (voice_transfer_flow, voice_trigger_flow, voice_forward_to_flow) or inbound_digital_flow (digital_transfer_flow).

string
length between 1 and 64

Filter Flow Triggers by resource id (exact match). For a number, the id of the number, not its phone number. Use it with resource_type.

string
length between 1 and 64

Filter Flow Triggers by intention (exact match): voice_inbound, voice_manual_outbound, voice_transfer_flow, voice_trigger_flow, digital_transfer_flow or voice_forward_to_flow. Merged with intentions if both are set.

intentions
array of strings

Filter Flow Triggers by several intentions; one matching any of them is returned. Repeat the parameter once per intention. Valid values are those of intention.

intentions
string
length between 1 and 64

Filter Flow Triggers by resource friendly name (case-insensitive, contains).

string
length between 1 and 256
Defaults to updated_at:desc

Sort by comma-separated fields, each with :asc or :desc (descending if omitted). Defaults to updated_at:desc.

integer
1 to 500
Defaults to 50

Flow Triggers per page, 1 to 500; any other value returns 400. Use per_page=1 to check whether any Flow Trigger matches.

integer
≥ 1
Defaults to 1

Number of the page to fetch (1-based).

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json