Workflows

Get workflows based on type

get

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

workflowTypestringOptional

Responses

200Success

application/json

get

/api/workflows-actions/workflows

HTTPcURLJavaScriptPython

GET /api/workflows-actions/workflows HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "consentId": 123,
    "organizationId": 456,
    "name": "Sample Workflow",
    "version": "1.0.0",
    "description": "This is a sample workflow",
    "createdBy": "admin",
    "attributes": {
      "key": "value"
    },
    "workflowType": "CONSENT",
    "workflowTask": []
  }
]

Create a workflow

post

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

consentIdintegerOptional

ID of the consent

Example: 123

organizationIdintegerOptional

ID of the organization

Example: 456

namestringRequired

Name of the workflow

Example: Sample Workflow

versionstringOptional

Version of the workflow

Example: 1.0.0

descriptionstringRequired

Description of the workflow

Example: This is a sample workflow

createdBystringOptional

Creator of the workflow

Example: admin

attributesobjectOptional

Additional attributes of the workflow

Example: {"key":"value"}

workflowTypestring · enumOptional

Type of the workflow

Example: CONSENTPossible values:

workflowTaskanyOptional

Tasks associated with the workflow

Responses

200Success

application/json

post

/api/workflows-actions/workflows

HTTPcURLJavaScriptPython

POST /api/workflows-actions/workflows HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 215

{
  "consentId": 123,
  "organizationId": 456,
  "name": "Sample Workflow",
  "version": "1.0.0",
  "description": "This is a sample workflow",
  "createdBy": "admin",
  "attributes": {
    "key": "value"
  },
  "workflowType": "CONSENT",
  "workflowTask": []
}

200Success

{
  "id": 1,
  "name": "text",
  "version": "text",
  "description": "text",
  "createdBy": "text",
  "attributes": {},
  "consentId": 1,
  "workflowType": "text",
  "workflowTask": [
    {
      "id": 1,
      "order": 1,
      "priority": 1,
      "name": "text",
      "linkId": "text",
      "description": "text",
      "taskType": "SURVEY",
      "attributes": {},
      "workflowId": 1,
      "workflowTaskActions": [
        {
          "action": "text",
          "workflowActionTaskId": 1,
          "id": 1,
          "createdAt": "2025-12-15",
          "updatedAt": "2025-12-15",
          "workflowTaskId": 1,
          "attributes": {}
        }
      ]
    }
  ],
  "WorkflowTask": [
    {
      "id": 1,
      "order": 1,
      "priority": 1,
      "name": "text",
      "linkId": "text",
      "description": "text",
      "taskType": "SURVEY",
      "attributes": {},
      "workflowId": 1,
      "workflowTaskActions": [
        {
          "action": "text",
          "workflowActionTaskId": 1,
          "id": 1,
          "createdAt": "2025-12-15",
          "updatedAt": "2025-12-15",
          "workflowTaskId": 1,
          "attributes": {}
        }
      ]
    }
  ]
}

Get workflow by ID

get

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

workflowIdnumberRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

get

/api/workflows-actions/workflows/{workflowId}

HTTPcURLJavaScriptPython

GET /api/workflows-actions/workflows/{workflowId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 1,
  "name": "text",
  "version": "text",
  "description": "text",
  "createdBy": "text",
  "attributes": {},
  "consentId": 1,
  "workflowType": "text",
  "workflowTask": [
    {
      "id": 1,
      "order": 1,
      "priority": 1,
      "name": "text",
      "linkId": "text",
      "description": "text",
      "taskType": "SURVEY",
      "attributes": {},
      "workflowId": 1,
      "workflowTaskActions": [
        {
          "action": "text",
          "workflowActionTaskId": 1,
          "id": 1,
          "createdAt": "2025-12-15",
          "updatedAt": "2025-12-15",
          "workflowTaskId": 1,
          "attributes": {}
        }
      ]
    }
  ],
  "WorkflowTask": [
    {
      "id": 1,
      "order": 1,
      "priority": 1,
      "name": "text",
      "linkId": "text",
      "description": "text",
      "taskType": "SURVEY",
      "attributes": {},
      "workflowId": 1,
      "workflowTaskActions": [
        {
          "action": "text",
          "workflowActionTaskId": 1,
          "id": 1,
          "createdAt": "2025-12-15",
          "updatedAt": "2025-12-15",
          "workflowTaskId": 1,
          "attributes": {}
        }
      ]
    }
  ]
}