Flows

Get Flow

GET

Path parameters

sidstringRequired

Query parameters

userIdentifierstringRequired
groupIdentifierstringOptional
versiondoubleOptional
tagenumOptional
include"block"Optional

Response

This endpoint returns an object
kind
"flow"
type
"flow"
uid
string
sid
string
version
double
state
object
blocks
list of objectsOptional
GET
$curl -G https://blocks.dopt.com/v2/flow/%3Asid \
> -H "x-api-key: <apiKey>" \
> -d userIdentifier=string \
> -d groupIdentifier=string \
> -d version=1
Response
1{
2 "kind": "flow",
3 "type": "flow",
4 "uid": "string",
5 "sid": "string",
6 "version": 1,
7 "state": {
8 "stopped": true,
9 "started": true,
10 "finished": true
11 },
12 "blocks": [
13 {
14 "kind": "block",
15 "uid": "string",
16 "sid": "string",
17 "version": 1,
18 "state": {
19 "active": true,
20 "entered": true,
21 "exited": true
22 },
23 "transitioned": {
24 "string": true
25 },
26 "type": "custom",
27 "fields": [
28 {
29 "type": "string",
30 "sid": "string",
31 "value": "string"
32 }
33 ],
34 "containerUid": "string"
35 }
36 ]
37}