Query Workflows

POST 
/preview/base/workflows/query

Query Workflows

Request

Query Parameters

workflow_ref any

JSON string of ref, e.g. {"key": value}

workflow_flags any

JSON string of flags, e.g. {"key": value}

workflow_metadata any

JSON string of metadata, e.g. {"key": value}

include_archived any

Responses

200

Successful Response

application/json

Schema

Schema

count Count (integer)required
workflowsobject[]

Array [

nameobject

anyOf

MOD1

string

descriptionobject

anyOf

MOD1

string

created_atobject

anyOf

MOD1

string

updated_atobject

anyOf

MOD1

string

deleted_atobject

anyOf

MOD1

string

created_by_idobject

anyOf

MOD1

string

updated_by_idobject

anyOf

MOD1

string

deleted_by_idobject

anyOf

MOD1

string

slugobject

anyOf

MOD1

string

idobject

anyOf

MOD1

string

flagsobject

anyOf

WorkflowFlags

is_customobject

anyOf

MOD1

boolean

is_evaluatorobject

anyOf

MOD1

boolean

is_humanobject

anyOf

MOD1

boolean

metadataobject

anyOf

]

Example (from schema)

{
  "count": 0,
  "workflows": [
    {
      "name": "string",
      "description": "string",
      "created_at": "2025-05-15T13:01:54.368Z",
      "updated_at": "2025-05-15T13:01:54.368Z",
      "deleted_at": "2025-05-15T13:01:54.368Z",
      "created_by_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "updated_by_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "deleted_by_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "slug": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "flags": {},
      "metadata": {}
    }
  ]
}

422

Validation Error

application/json

Schema

Schema

detailobject[]

Array [

locobject[]required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...