Get Flow

GET

Path parameters

sidstringRequired

Query parameters

userIdentifierstringRequired

groupIdentifierstringOptional

versiondoubleOptional

tag"uncommitted" or "latest"Optional

Allowed values: uncommittedlatest

include"block"OptionalDefaults to block

Response

This endpoint returns an object.

kind"flow"Defaults to flow

type"flow"Defaults to flow

uidstring

sidstring

versiondouble

stateobject

blockslist of objectsOptional

GET

1 curl -G https://blocks.dopt.com/v2/flow/:sid \
2      -H "x-api-key: <apiKey>" \
3      -d userIdentifier=string \
4      -d groupIdentifier=string \
5      -d version=1

200Retrieved

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 }

Built with

1	curl -G https://blocks.dopt.com/v2/flow/:sid \
2	-H "x-api-key: <apiKey>" \
3	-d userIdentifier=string \
4	-d groupIdentifier=string \
5	-d version=1

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	}