Workflow
Get a workflow
Getting Started
Workflow
Processors
Organizations
Patients
Voice Notes
Transcripts
- GETGet paginated finalized sentences for a voice note
- GETFetch details for multiple finalized sentences
- POSTSearch sentences by embedding
- POSTSave voice note audio
- POSTGenerate audio upload URL
- GETGenerate presigned voice note audio URL
- GETGet list of questions to check in transcripts
- GETGet the answered status of predefined questions for a voice note
Survey
Visits
Workflow
Get a workflow
GET
/
v1
/
workflows
/
{workflowId}
curl --request GET \
--url https://app.enzo.health/api/v1/workflows/{workflowId} \
--header 'Authorization: Bearer <token>'
{
"workflow": {
"version": "1",
"groups": [
{
"id": "<string>",
"title": "<string>",
"graphCoordinates": {
"x": 123,
"y": 123
},
"blocks": [
{
"id": "<string>",
"outgoingEdgeId": "<string>",
"type": "text input",
"options": {
"labels": {
"placeholder": "<string>",
"button": "<string>"
},
"variableId": "<string>",
"isLong": true
}
}
]
}
],
"events": [
{
"id": "<string>",
"outgoingEdgeId": "<string>",
"graphCoordinates": {
"x": 123,
"y": 123
},
"type": "start"
}
],
"id": "<string>",
"name": "<string>",
"icon": "<string>",
"edges": [
{
"id": "<string>",
"from": {
"blockId": "<string>",
"itemId": "<string>"
},
"to": {
"groupId": "<string>",
"blockId": "<string>"
}
}
],
"variables": [
{
"id": "<string>",
"name": "<string>",
"groupId": "<string>",
"isSessionVariable": true,
"value": "<string>"
}
],
"createdAt": "<string>",
"updatedAt": "<string>",
"folderId": "<string>",
"publicId": "<string>",
"organizationId": "<string>",
"resultsTablePreferences": {
"columnsOrder": [
"<string>"
],
"columnsVisibility": {},
"columnsWidth": {}
},
"isArchived": true,
"isClosed": true
},
"currentUserMode": "guest"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Query Parameters
If enabled, the workflow will be converted to the latest schema version
Response
200
application/json
Successful response
Available options:
text input
Available options:
guest
, read
, write
curl --request GET \
--url https://app.enzo.health/api/v1/workflows/{workflowId} \
--header 'Authorization: Bearer <token>'
{
"workflow": {
"version": "1",
"groups": [
{
"id": "<string>",
"title": "<string>",
"graphCoordinates": {
"x": 123,
"y": 123
},
"blocks": [
{
"id": "<string>",
"outgoingEdgeId": "<string>",
"type": "text input",
"options": {
"labels": {
"placeholder": "<string>",
"button": "<string>"
},
"variableId": "<string>",
"isLong": true
}
}
]
}
],
"events": [
{
"id": "<string>",
"outgoingEdgeId": "<string>",
"graphCoordinates": {
"x": 123,
"y": 123
},
"type": "start"
}
],
"id": "<string>",
"name": "<string>",
"icon": "<string>",
"edges": [
{
"id": "<string>",
"from": {
"blockId": "<string>",
"itemId": "<string>"
},
"to": {
"groupId": "<string>",
"blockId": "<string>"
}
}
],
"variables": [
{
"id": "<string>",
"name": "<string>",
"groupId": "<string>",
"isSessionVariable": true,
"value": "<string>"
}
],
"createdAt": "<string>",
"updatedAt": "<string>",
"folderId": "<string>",
"publicId": "<string>",
"organizationId": "<string>",
"resultsTablePreferences": {
"columnsOrder": [
"<string>"
],
"columnsVisibility": {},
"columnsWidth": {}
},
"isArchived": true,
"isClosed": true
},
"currentUserMode": "guest"
}