Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Account to apply operations to
Workflow to apply operations to
Response
successful operation
The response is of type object
.
curl --request GET \
--url https://api.sakari.io/v1/accounts/{accountId}/workflows/{workflowId} \
--header 'Authorization: Bearer <token>'
{
"success": true,
"data": {
"id": "<string>",
"name": "<string>",
"versions": [
{
"id": "<string>",
"name": "<string>",
"definition": {
"nodes": [
{
"id": "<string>",
"type": {
"id": "<string>",
"type": "<string>",
"group": "<string>",
"name": "<string>",
"label": "<string>",
"description": "<string>",
"icon": "<string>",
"properties": [
{}
],
"outputs": [
{
"default": true,
"path": "<string>",
"name": "<string>",
"dataType": "boolean"
}
],
"validation": {
"numEdgeCondition": "exactly",
"numEdges": 123,
"edges": [
{}
]
},
"supportsReenrollment": true,
"color": "<string>",
"status": "<string>",
"supportLink": "<string>"
},
"config": {
"message": "<string>",
"groups": [
"<any>"
]
}
}
],
"edges": [
{
"id": "<string>",
"type": "standard",
"source": "<string>",
"target": "<string>",
"value": "<string>"
}
],
"properties": [
{
"name": "<string>",
"dataType": "string",
"created": {
"at": "2023-11-07T05:31:56Z"
}
}
]
},
"readonly": true,
"active": "2023-11-07T05:31:56Z",
"lastActive": "2023-11-07T05:31:56Z",
"created": {
"at": "2023-11-07T05:31:56Z",
"by": {
"id": "<string>",
"name": "Joe Bloggs",
"firstName": "Joe",
"lastName": "Bloggs",
"email": "joe@bloggs.com",
"source": "<string>",
"subSource": "<string>"
}
},
"updated": {
"at": "2023-11-07T05:31:56Z",
"by": {
"id": "<string>",
"name": "Joe Bloggs",
"firstName": "Joe",
"lastName": "Bloggs",
"email": "joe@bloggs.com",
"source": "<string>",
"subSource": "<string>"
}
}
}
],
"created": {
"at": "2023-11-07T05:31:56Z",
"by": {
"id": "<string>",
"name": "Joe Bloggs",
"firstName": "Joe",
"lastName": "Bloggs",
"email": "joe@bloggs.com",
"source": "<string>",
"subSource": "<string>"
}
},
"updated": {
"at": "2023-11-07T05:31:56Z",
"by": {
"id": "<string>",
"name": "Joe Bloggs",
"firstName": "Joe",
"lastName": "Bloggs",
"email": "joe@bloggs.com",
"source": "<string>",
"subSource": "<string>"
}
}
}
}
curl --request GET \
--url https://api.sakari.io/v1/accounts/{accountId}/workflows/{workflowId} \
--header 'Authorization: Bearer <token>'
{
"success": true,
"data": {
"id": "<string>",
"name": "<string>",
"versions": [
{
"id": "<string>",
"name": "<string>",
"definition": {
"nodes": [
{
"id": "<string>",
"type": {
"id": "<string>",
"type": "<string>",
"group": "<string>",
"name": "<string>",
"label": "<string>",
"description": "<string>",
"icon": "<string>",
"properties": [
{}
],
"outputs": [
{
"default": true,
"path": "<string>",
"name": "<string>",
"dataType": "boolean"
}
],
"validation": {
"numEdgeCondition": "exactly",
"numEdges": 123,
"edges": [
{}
]
},
"supportsReenrollment": true,
"color": "<string>",
"status": "<string>",
"supportLink": "<string>"
},
"config": {
"message": "<string>",
"groups": [
"<any>"
]
}
}
],
"edges": [
{
"id": "<string>",
"type": "standard",
"source": "<string>",
"target": "<string>",
"value": "<string>"
}
],
"properties": [
{
"name": "<string>",
"dataType": "string",
"created": {
"at": "2023-11-07T05:31:56Z"
}
}
]
},
"readonly": true,
"active": "2023-11-07T05:31:56Z",
"lastActive": "2023-11-07T05:31:56Z",
"created": {
"at": "2023-11-07T05:31:56Z",
"by": {
"id": "<string>",
"name": "Joe Bloggs",
"firstName": "Joe",
"lastName": "Bloggs",
"email": "joe@bloggs.com",
"source": "<string>",
"subSource": "<string>"
}
},
"updated": {
"at": "2023-11-07T05:31:56Z",
"by": {
"id": "<string>",
"name": "Joe Bloggs",
"firstName": "Joe",
"lastName": "Bloggs",
"email": "joe@bloggs.com",
"source": "<string>",
"subSource": "<string>"
}
}
}
],
"created": {
"at": "2023-11-07T05:31:56Z",
"by": {
"id": "<string>",
"name": "Joe Bloggs",
"firstName": "Joe",
"lastName": "Bloggs",
"email": "joe@bloggs.com",
"source": "<string>",
"subSource": "<string>"
}
},
"updated": {
"at": "2023-11-07T05:31:56Z",
"by": {
"id": "<string>",
"name": "Joe Bloggs",
"firstName": "Joe",
"lastName": "Bloggs",
"email": "joe@bloggs.com",
"source": "<string>",
"subSource": "<string>"
}
}
}
}
The access token received from the authorization server in the OAuth 2.0 flow.
Account to apply operations to
Workflow to apply operations to
successful operation
The response is of type object
.