Flows

Get Flow

GET
https://blocks.dopt.com/v2/flow/:sid

Path parameters

sid
string

Query parameters

userIdentifier
string
groupIdentifier
optional string
version
optional double
tag
optional enum
Allowed values: uncommittedlatest
include
optional "block"

Response

This endpoint return an object.
kind
"flow"
type
"flow"
uid
string
sid
string
version
double
state
object
blocks
optional list of objects
GET
/v2/flow/:sid
curl -G https://blocks.dopt.com/v2/flow/:sid \
-H "x-api-key: <apiKey>" \
-d userIdentifier=string \
-d groupIdentifier=string \
-d version=1
Response
{
"kind": "flow",
"type": "flow",
"uid": "string",
"sid": "string",
"version": 1,
"state": {
"stopped": true,
"started": true,
"finished": true
},
"blocks": [
{
"kind": "block",
"uid": "string",
"sid": "string",
"version": 1,
"state": {
"active": true,
"entered": true,
"exited": true
},
"transitioned": {
"string": true
},
"type": "custom",
"fields": [
{
"type": "string",
"sid": "string",
"value": "string"
}
],
"containerUid": "string"
}
]
}