Dots home pagelight logo
  1. Flows
  2. Retrieve a Flow
GET

/api/v2/flows/{flow_id}

client_id*
api_key*
curl --request GET \
     --url https://api.senddotssandbox.com/api/v2/flows/{flow_id} \
     --header 'Authorization: Basic AUTH_VALUE'

​
Parameters

flow_idRequired
string

Id of the flow to fetch

​
Response

id
string

ID of the flow.

created
string

Date that the flow was created.

user_id
string | null

ID of the user that has claimed the flow.

steps
string[]

Array of steps in the flow.

completed_steps
string[]

Array of steps that have been completed in the flow.

link
string

URL to access the flow. Can be embedded in an iframe.

metadata
string | object | null

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.