Workflows

Workflows coordinate user tasks and automated system actions in the Validere platform.

https://api.validere.io/app

Workflow Categories

List workflow categories

GET

Authorizations

StagingIntegrationLocal

Query parameters

namestringOptional

Workflow Category name

descriptionstringOptional

Workflow Category description

page_sizenumberOptional

page size

pagenumberOptional

page number

sort_bystringOptional

sort by

sort_directionstring · enumOptional

sort direction

Example: descPossible values:

Responses

200

A successful operation

application/json

GET

/app/v1/workflow_categories

HTTPcURLJavaScriptPython

GET /app/v1/workflow_categories HTTP/1.1
Host: api.validere.io
Accept: */*

200

A successful operation

{
  "page_number": 0,
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "company_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "created_at": "text",
      "updated_at": "text",
      "created_by": "123e4567-e89b-12d3-a456-426614174000",
      "updated_by": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Get a workflow category

GET

Authorizations

StagingIntegrationLocal

Path parameters

idstring · uuidRequired

Workflow Category ID

Responses

200

A successful operation

application/json

idstring · uuidRequired

company_idstring · uuidRequired

namestringRequired

descriptionstringRequired

created_atany ofRequired

stringOptional

or

string · date-timeOptional

updated_atany ofRequired

stringOptional

or

string · date-timeOptional

created_bystring · uuidRequired

updated_bystring · uuidRequired

GET

/app/v1/workflow_categories/{id}

HTTPcURLJavaScriptPython

GET /app/v1/workflow_categories/{id} HTTP/1.1
Host: api.validere.io
Accept: */*

200

A successful operation

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "company_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "created_at": "text",
  "updated_at": "text",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000"
}

Workflow Templates

Get a workflow template

GET

Authorizations

StagingIntegrationLocal

Path parameters

idstring · uuidRequired

Workflow Template ID

Responses

200

A successful operation

application/json

GET

/app/v1/workflow_templates/{id}

HTTPcURLJavaScriptPython

GET /app/v1/workflow_templates/{id} HTTP/1.1
Host: api.validere.io
Accept: */*

200

A successful operation

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "company_id": "123e4567-e89b-12d3-a456-426614174000",
  "category_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "version": 1,
  "status": "archive",
  "triggers": [
    {
      "type": "scheduled",
      "due_date": {
        "time_period": "hours",
        "duration": 1,
        "start_variable": "text"
      },
      "notification_date": {
        "time_period": "hours",
        "duration": 1
      },
      "output": {
        "$TRIGGERING_ASSET_ID": "$.asset_trigger.metadata.id",
        "$LEAK_EQUIPMENT": "$.answers.section1[0].question_leak.value",
        "$ASSOCIATED_ASSET_ID": "$.asset.id",
        "$ASSOCIATED_ASSET_NAME": "$.asset.name",
        "$ASSOCIATED_ASSET_TYPE": "$.asset.asset_type",
        "$FOO": "bar"
      },
      "cron": "0 8 * * ? *"
    }
  ],
  "config": {
    "start": "text",
    "steps": {
      "ANY_ADDITIONAL_PROPERTY": {
        "type": "system_action",
        "name": "text",
        "description": "text",
        "next": "text",
        "end": true,
        "task": {
          "output": {
            "$TRIGGERING_ASSET_ID": "$.asset_trigger.metadata.id",
            "$LEAK_EQUIPMENT": "$.answers.section1[0].question_leak.value",
            "$ASSOCIATED_ASSET_ID": "$.asset.id",
            "$ASSOCIATED_ASSET_NAME": "$.asset.name",
            "$ASSOCIATED_ASSET_TYPE": "$.asset.asset_type",
            "$FOO": "bar"
          },
          "input": {
            "$.description": "foo",
            "$.questions.question_leak.default_answer": "$LEAK_EQUIPMENT"
          },
          "type": "create_event",
          "event_schema_id": "123e4567-e89b-12d3-a456-426614174000",
          "event_status": "open"
        }
      }
    },
    "workflow_name": "text",
    "workflow_description": "text"
  },
  "output": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "workflow_notifications": {
    "events": [
      {
        "type": "created"
      }
    ],
    "recipients": [
      {
        "type": "owner"
      }
    ],
    "channels": [
      {
        "type": "email"
      }
    ]
  },
  "workflow_task_notifications": {
    "events": [
      {
        "type": "created"
      }
    ],
    "recipients": [
      {
        "type": "workflow_owner"
      }
    ],
    "channels": [
      {
        "type": "email"
      }
    ],
    "input": {
      "$.description": "text"
    },
    "step_ids": [
      "text"
    ],
    "task_status": [
      "open"
    ]
  },
  "asset_type": "asset_group",
  "asset_filter": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "workflow_owner_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "text",
  "updated_at": "text",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000",
  "facility_filter": {
    "custom_attributes.hint": "View schema for all supported fields",
    "custom_attributes.operator": "bob",
    "name": {
      "$like": "wind"
    }
  }
}

Search Workflow Templates

POST

Authorizations

StagingIntegrationLocal

Body

application/json

and

and

Responses

200

Successfully operation

application/json

POST

/app/v1/workflow_templates/search

HTTPcURLJavaScriptPython

POST /app/v1/workflow_templates/search HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 281

{
  "page": 0,
  "page_size": 20,
  "sort_by": "name",
  "sort_direction": "desc",
  "filter": {
    "category_id": "1b154c71-67be-1f51-40ce-3aefb42a6480",
    "status": "active",
    "created_by": "1b154c71-67be-1f51-40ce-3aefb42a6480",
    "created_at": {
      "$gt": "2023-07-01T08:19:25.438Z",
      "$lt": "2023-07-30T08:19:25.438Z"
    }
  }
}

200

Successfully operation

{
  "page_number": 0,
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "company_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "created_at": "text",
      "updated_at": "text",
      "created_by": "123e4567-e89b-12d3-a456-426614174000",
      "updated_by": "123e4567-e89b-12d3-a456-426614174000",
      "facilities": {
        "page_number": 0,
        "page_size": 10,
        "total_entries": 58,
        "total_pages": 6,
        "data": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text"
          }
        ]
      }
    }
  ]
}

Workflow Tasks

Get a workflow task

GET

Authorizations

StagingIntegrationLocal

Path parameters

workflow_task_idstring · uuidRequired

Workflow Task ID

Responses

200

A successful operation

application/json

or

GET

/app/v1/workflow_tasks/{workflow_task_id}

HTTPcURLJavaScriptPython

GET /app/v1/workflow_tasks/{workflow_task_id} HTTP/1.1
Host: api.validere.io
Accept: */*

200

A successful operation

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "company_id": "123e4567-e89b-12d3-a456-426614174000",
  "workflow_id": "123e4567-e89b-12d3-a456-426614174000",
  "step_id": "text",
  "name": "text",
  "description": "text",
  "status": "open",
  "is_dismissible": true,
  "type": "manual_task",
  "assignee_user": "text",
  "assignee_group": "text",
  "restrict_assignee_completion": true,
  "callback_token": "text",
  "due_date": "text",
  "created_at": "text",
  "updated_at": "text",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000"
}

Search Workflow Tasks

POST

Authorizations

StagingIntegrationLocal

Body

application/json

and

and

Responses

200

Successfully operation

application/json

POST

/app/v1/workflow_tasks/search

HTTPcURLJavaScriptPython

POST /app/v1/workflow_tasks/search HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 152

{
  "page": 0,
  "page_size": 20,
  "sort_by": "created_at",
  "sort_direction": "desc",
  "filter": {
    "workflow_id": "1b154c71-67be-1f51-40ce-3aefb42a6480",
    "status": "open"
  }
}

200

Successfully operation

{
  "page_number": 0,
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "company_id": "123e4567-e89b-12d3-a456-426614174000",
      "workflow_id": "123e4567-e89b-12d3-a456-426614174000",
      "step_id": "text",
      "name": "text",
      "description": "text",
      "status": "open",
      "is_dismissible": true,
      "type": "manual_task",
      "assignee_user": "text",
      "assignee_group": "text",
      "restrict_assignee_completion": true,
      "callback_token": "text",
      "due_date": "text",
      "created_at": "text",
      "updated_at": "text",
      "updated_by": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Search Workflow Steps

POST

Authorizations

StagingIntegrationLocal

Body

application/json

and

and

Responses

200

Successfully operation

application/json

POST

/app/v1/workflow_tasks/steps/search

HTTPcURLJavaScriptPython

POST /app/v1/workflow_tasks/steps/search HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 152

{
  "page": 0,
  "page_size": 20,
  "sort_by": "created_at",
  "sort_direction": "desc",
  "filter": {
    "workflow_id": "1b154c71-67be-1f51-40ce-3aefb42a6480",
    "status": "open"
  }
}

200

Successfully operation

{
  "page_number": 0,
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workflow_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "due_date": "2026-03-13T21:37:37.785Z",
      "is_dismissible": true,
      "type": "create_event",
      "step_id": "text",
      "step_type": "system_action",
      "status": "open",
      "assignee_user": "123e4567-e89b-12d3-a456-426614174000",
      "assignee_group": "123e4567-e89b-12d3-a456-426614174000",
      "assignee_to": "123e4567-e89b-12d3-a456-426614174000",
      "restrict_assignee_completion": true,
      "entity_id": "123e4567-e89b-12d3-a456-426614174000",
      "entity_name": "text",
      "created_at": "2026-03-13T21:37:37.785Z",
      "updated_at": "2026-03-13T21:37:37.785Z"
    }
  ]
}

Get a workflow action

GET

Authorizations

StagingIntegrationLocal

Path parameters

workflow_action_idstring · uuidRequired

Workflow Action ID

Responses

200

A successful operation

application/json

idstring · uuidRequired

company_idstring · uuidRequired

workflow_idstring · uuidRequired

step_idstringRequired

namestringRequired

descriptionstringRequired

typestring · enumRequiredPossible values:

created_atstringRequired

GET

/app/v1/workflow_tasks/actions/{workflow_action_id}

HTTPcURLJavaScriptPython

GET /app/v1/workflow_tasks/actions/{workflow_action_id} HTTP/1.1
Host: api.validere.io
Accept: */*

200

A successful operation

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "company_id": "123e4567-e89b-12d3-a456-426614174000",
  "workflow_id": "123e4567-e89b-12d3-a456-426614174000",
  "step_id": "text",
  "name": "text",
  "description": "text",
  "type": "create_event",
  "created_at": "text"
}

Workflows

Get a workflow

GET

Authorizations

StagingIntegrationLocal

Path parameters

workflow_idstring · uuidRequired

Workflow ID

Responses

200

A successful operation

application/json

idstring · uuidRequired

namestringRequired

descriptionstringRequired

company_idstring · uuidRequired

workflow_template_idstring · uuidRequired

statusstring · enumRequiredPossible values:

due_dateany ofRequired

stringOptional

or

string · date-timeOptional

notification_dateany ofOptional

stringOptional

or

string · date-timeOptional

created_atany ofRequired

stringOptional

or

string · date-timeOptional

updated_atany ofRequired

stringOptional

or

string · date-timeOptional

created_bystring · uuidRequired

updated_bystring · uuidRequired

GET

/app/v1/workflows/{workflow_id}

HTTPcURLJavaScriptPython

GET /app/v1/workflows/{workflow_id} HTTP/1.1
Host: api.validere.io
Accept: */*

200

A successful operation

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "company_id": "123e4567-e89b-12d3-a456-426614174000",
  "workflow_template_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "complete",
  "config": {
    "start": "text",
    "steps": {
      "ANY_ADDITIONAL_PROPERTY": {
        "type": "system_action",
        "name": "text",
        "description": "text",
        "next": "text",
        "end": true,
        "task": {
          "output": {
            "$TRIGGERING_ASSET_ID": "$.asset_trigger.metadata.id",
            "$LEAK_EQUIPMENT": "$.answers.section1[0].question_leak.value",
            "$ASSOCIATED_ASSET_ID": "$.asset.id",
            "$ASSOCIATED_ASSET_NAME": "$.asset.name",
            "$ASSOCIATED_ASSET_TYPE": "$.asset.asset_type",
            "$FOO": "bar"
          },
          "input": {
            "$.description": "foo",
            "$.questions.question_leak.default_answer": "$LEAK_EQUIPMENT"
          },
          "type": "create_event",
          "event_schema_id": "123e4567-e89b-12d3-a456-426614174000",
          "event_status": "open"
        }
      }
    },
    "workflow_name": "text",
    "workflow_description": "text"
  },
  "variables": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "step_states": {
    "ANY_ADDITIONAL_PROPERTY": "pending"
  },
  "due_date": "text",
  "notification_date": "text",
  "created_at": "text",
  "updated_at": "text",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000"
}

Search Workflows

POST

Authorizations

StagingIntegrationLocal

Body

application/json

and

and

Responses

200

Successfully operation

application/json

POST

/app/v1/workflows/search

HTTPcURLJavaScriptPython

POST /app/v1/workflows/search HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 287

{
  "page": 0,
  "page_size": 20,
  "sort_by": "created_at",
  "sort_direction": "desc",
  "filter": {
    "category_id": "1b154c71-67be-1f51-40ce-3aefb42a6480",
    "status": "active",
    "created_by": "1b154c71-67be-1f51-40ce-3aefb42a6480",
    "created_at": {
      "$gt": "2023-07-01T08:19:25.438Z",
      "$lt": "2023-07-30T08:19:25.438Z"
    }
  }
}

200

Successfully operation

{
  "page_number": 0,
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "company_id": "123e4567-e89b-12d3-a456-426614174000",
      "workflow_template_id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "complete",
      "config": {
        "start": "text",
        "steps": {
          "ANY_ADDITIONAL_PROPERTY": {
            "type": "system_action",
            "name": "text",
            "description": "text",
            "next": "text",
            "end": true,
            "task": {
              "output": {
                "$TRIGGERING_ASSET_ID": "$.asset_trigger.metadata.id",
                "$LEAK_EQUIPMENT": "$.answers.section1[0].question_leak.value",
                "$ASSOCIATED_ASSET_ID": "$.asset.id",
                "$ASSOCIATED_ASSET_NAME": "$.asset.name",
                "$ASSOCIATED_ASSET_TYPE": "$.asset.asset_type",
                "$FOO": "bar"
              },
              "input": {
                "$.description": "foo",
                "$.questions.question_leak.default_answer": "$LEAK_EQUIPMENT"
              },
              "type": "create_event",
              "event_schema_id": "123e4567-e89b-12d3-a456-426614174000",
              "event_status": "open"
            }
          }
        },
        "workflow_name": "text",
        "workflow_description": "text"
      },
      "variables": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "step_states": {
        "ANY_ADDITIONAL_PROPERTY": "pending"
      },
      "due_date": "text",
      "notification_date": "text",
      "created_at": "text",
      "updated_at": "text",
      "created_by": "123e4567-e89b-12d3-a456-426614174000",
      "updated_by": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Search form submissions on a workflow

POST

Authorizations

StagingIntegrationLocal

Path parameters

workflow_idstring · uuidRequired

Workflow ID

Body

application/json

and

and

and

objectOptional

Responses

200

successful operation

application/json

POST

/app/v1/workflows/{workflow_id}/form_submissions/search

HTTPcURLJavaScriptPython

POST /app/v1/workflows/{workflow_id}/form_submissions/search HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 1115

{
  "page": 0,
  "page_size": 20,
  "sort_by": "created_at",
  "sort_direction": "asc",
  "filter": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "version": 1,
    "current_version": true,
    "status": "pending",
    "form_category_id": {
      "$in": [
        "748970de-fd1f-4494-ae3f-47cc21ff205f"
      ]
    },
    "form_category.name": "test",
    "form_schema.id": {
      "$in": [
        "748970de-fd1f-4494-ae3f-47cc21ff205f"
      ]
    },
    "form_schema.name": "text",
    "form_schema.version": 1,
    "form_schema.current_version": true,
    "form_schema.status": "active",
    "related_entity_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_by": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2026-03-13T21:37:37.785Z",
    "updated_at": "2026-03-13T21:37:37.785Z",
    "event.id": "123e4567-e89b-12d3-a456-426614174000",
    "measurement.measurement_type": "text",
    "measurement.measurement_unit": "text",
    "measurement.source_id": "123e4567-e89b-12d3-a456-426614174000",
    "measurement.subject_id": "123e4567-e89b-12d3-a456-426614174000",
    "measurement.form_submission_id": "123e4567-e89b-12d3-a456-426614174000",
    "measurement.section_id": "text",
    "measurement.question_id": "text",
    "measurement.question_index": 1,
    "measurement.time": "2026-03-13T21:37:37.785Z"
  }
}

200

successful operation

{
  "page_number": 0,
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "company_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_by": "123e4567-e89b-12d3-a456-426614174000",
      "form_schema_id": "123e4567-e89b-12d3-a456-426614174000",
      "form_schema_version": 1,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "pending",
      "form_schema": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "form_category": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        }
      }
    },
    {
      "associated_tasks": [
        {
          "workflow_task_name": "text",
          "workflow_task_id": "123e4567-e89b-12d3-a456-426614174000",
          "form_submission_id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "associated_actions": [
        {
          "workflow_action_name": "text",
          "workflow_action_id": "123e4567-e89b-12d3-a456-426614174000",
          "form_submission_id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "is_workflow_trigger": true
    }
  ]
}