Clarity Workflows Admin API
The workflows_admin API from Clarity — 12 operation(s) for workflows_admin.
The workflows_admin API from Clarity — 12 operation(s) for workflows_admin.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/onclarity-com:onclarity-com-workflows-admin-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Fast Workflows Admin API
version: 0.1.0
tags:
- name: workflows_admin
paths:
/api/admin/v1/workflows/webhooks:
get:
tags:
- workflows_admin
summary: List Webhooks
description: The project's webhook configurations (filters + target webhook_url + workflow_id).
operationId: list_webhooks_api_admin_v1_workflows_webhooks_get
security:
- HTTPBearer: []
parameters:
- name: project_id
in: query
required: true
schema:
type: integer
title: Project Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- workflows_admin
summary: Create Webhook
description: 'Bind filters to an existing flow (ownership-checked) so matching events fire it.
Unlike the user contour''s POST /api/v1/webhooks/workflow (which creates a bare
flow and binds it in one step), this binds a flow that already exists — the
admin surface separates flow authoring from wiring.'
operationId: create_webhook_api_admin_v1_workflows_webhooks_post
security:
- HTTPBearer: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/src__routers__workflows_admin__AdminCreateWebhookRequest'
responses:
'201':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/admin/v1/workflows/webhooks/{webhook_id}:
delete:
tags:
- workflows_admin
summary: Delete Webhook
description: 'Remove a webhook binding. ``delete_flow=true`` additionally deletes the bound
Activepieces flow (the user contour''s semantics); default leaves the flow intact
since the admin surface manages flows independently.'
operationId: delete_webhook_api_admin_v1_workflows_webhooks__webhook_id__delete
security:
- HTTPBearer: []
parameters:
- name: webhook_id
in: path
required: true
schema:
type: string
format: uuid
title: Webhook Id
- name: project_id
in: query
required: true
schema:
type: integer
title: Project Id
- name: delete_flow
in: query
required: false
schema:
type: boolean
default: false
title: Delete Flow
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/admin/v1/workflows:
get:
tags:
- workflows_admin
summary: List Workflows
description: 'List a project''s flows (AP seek pagination), each enriched with its webhook URLs.
A tenant with no AP project yet gets an empty page, not a 404 — "no workflows" is a
normal state for reads.'
operationId: list_workflows_api_admin_v1_workflows_get
security:
- HTTPBearer: []
parameters:
- name: project_id
in: query
required: true
schema:
type: integer
title: Project Id
- name: limit
in: query
required: false
schema:
type: integer
default: 100
title: Limit
- name: cursor
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Cursor
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- workflows_admin
summary: Create Workflow
description: 'Create a flow (creating the tenant''s AP project on demand). When ``trigger`` is
given, apply it via IMPORT_FLOW in the same call so the flow lands complete.'
operationId: create_workflow_api_admin_v1_workflows_post
security:
- HTTPBearer: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AdminCreateWorkflowRequest'
responses:
'201':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/admin/v1/workflows/pieces:
get:
tags:
- workflows_admin
summary: List Pieces
description: 'Installed pieces (name + version) visible to the project — needed to pin
``pieceVersion`` when composing a trigger tree.'
operationId: list_pieces_api_admin_v1_workflows_pieces_get
security:
- HTTPBearer: []
parameters:
- name: project_id
in: query
required: true
schema:
type: integer
title: Project Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/admin/v1/workflows/{flow_id}:
get:
tags:
- workflows_admin
summary: Get Workflow
description: One flow's full version tree (ownership-checked).
operationId: get_workflow_api_admin_v1_workflows__flow_id__get
security:
- HTTPBearer: []
parameters:
- name: flow_id
in: path
required: true
schema:
type: string
title: Flow Id
- name: project_id
in: query
required: true
schema:
type: integer
title: Project Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- workflows_admin
summary: Delete Workflow
operationId: delete_workflow_api_admin_v1_workflows__flow_id__delete
security:
- HTTPBearer: []
parameters:
- name: flow_id
in: path
required: true
schema:
type: string
title: Flow Id
- name: project_id
in: query
required: true
schema:
type: integer
title: Project Id
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/admin/v1/workflows/{flow_id}/runs:
get:
tags:
- workflows_admin
summary: List Workflow Runs
description: Recent runs for a flow (newest first).
operationId: list_workflow_runs_api_admin_v1_workflows__flow_id__runs_get
security:
- HTTPBearer: []
parameters:
- name: flow_id
in: path
required: true
schema:
type: string
title: Flow Id
- name: project_id
in: query
required: true
schema:
type: integer
title: Project Id
- name: limit
in: query
required: false
schema:
type: integer
default: 10
title: Limit
- name: cursor
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Cursor
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/admin/v1/workflows/{flow_id}/runs/{run_id}:
get:
tags:
- workflows_admin
summary: Get Workflow Run
description: 'Run detail with per-step input/output — read this before theorizing about a
misbehaving flow.'
operationId: get_workflow_run_api_admin_v1_workflows__flow_id__runs__run_id__get
security:
- HTTPBearer: []
parameters:
- name: flow_id
in: path
required: true
schema:
type: string
title: Flow Id
- name: run_id
in: path
required: true
schema:
type: string
title: Run Id
- name: project_id
in: query
required: true
schema:
type: integer
title: Project Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/admin/v1/workflows/{flow_id}/import:
post:
tags:
- workflows_admin
summary: Import Workflow
description: 'Replace a flow''s draft definition with the given trigger tree (IMPORT_FLOW is a
single all-or-nothing operation; the current version''s schemaVersion is reused).'
operationId: import_workflow_api_admin_v1_workflows__flow_id__import_post
security:
- HTTPBearer: []
parameters:
- name: flow_id
in: path
required: true
schema:
type: string
title: Flow Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AdminImportWorkflowRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/admin/v1/workflows/{flow_id}/publish:
post:
tags:
- workflows_admin
summary: Publish Workflow
description: Lock and publish the flow's draft version (flow becomes ENABLED).
operationId: publish_workflow_api_admin_v1_workflows__flow_id__publish_post
security:
- HTTPBearer: []
parameters:
- name: flow_id
in: path
required: true
schema:
type: string
title: Flow Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AdminWorkflowBody'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/admin/v1/workflows/{flow_id}/enable:
post:
tags:
- workflows_admin
summary: Enable Workflow
operationId: enable_workflow_api_admin_v1_workflows__flow_id__enable_post
security:
- HTTPBearer: []
parameters:
- name: flow_id
in: path
required: true
schema:
type: string
title: Flow Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AdminWorkflowBody'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/admin/v1/workflows/{flow_id}/disable:
post:
tags:
- workflows_admin
summary: Disable Workflow
operationId: disable_workflow_api_admin_v1_workflows__flow_id__disable_post
security:
- HTTPBearer: []
parameters:
- name: flow_id
in: path
required: true
schema:
type: string
title: Flow Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AdminWorkflowBody'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/admin/v1/workflows/{flow_id}/rename:
post:
tags:
- workflows_admin
summary: Rename Workflow
operationId: rename_workflow_api_admin_v1_workflows__flow_id__rename_post
security:
- HTTPBearer: []
parameters:
- name: flow_id
in: path
required: true
schema:
type: string
title: Flow Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AdminRenameWorkflowRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
src__routers__workflows_admin__AdminCreateWebhookRequest:
properties:
project_id:
type: integer
title: Project Id
name:
type: string
title: Name
filters:
items:
$ref: '#/components/schemas/WebhookFilter'
type: array
title: Filters
flow_id:
type: string
title: Flow Id
type: object
required:
- project_id
- name
- filters
- flow_id
title: AdminCreateWebhookRequest
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
AdminWorkflowBody:
properties:
project_id:
type: integer
title: Project Id
type: object
required:
- project_id
title: AdminWorkflowBody
AdminRenameWorkflowRequest:
properties:
project_id:
type: integer
title: Project Id
display_name:
type: string
title: Display Name
type: object
required:
- project_id
- display_name
title: AdminRenameWorkflowRequest
WebhookFilter:
properties:
key:
type: string
title: Key
type:
type: string
title: Type
operator:
type: string
title: Operator
values:
anyOf:
- items: {}
type: array
- type: 'null'
title: Values
value:
anyOf:
- {}
- type: 'null'
title: Value
type: object
required:
- key
- type
- operator
title: WebhookFilter
AdminCreateWorkflowRequest:
properties:
project_id:
type: integer
title: Project Id
display_name:
type: string
title: Display Name
trigger:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Trigger
type: object
required:
- project_id
- display_name
title: AdminCreateWorkflowRequest
AdminImportWorkflowRequest:
properties:
project_id:
type: integer
title: Project Id
display_name:
type: string
title: Display Name
trigger:
additionalProperties: true
type: object
title: Trigger
type: object
required:
- project_id
- display_name
- trigger
title: AdminImportWorkflowRequest
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
HTTPBasic:
type: http
scheme: basic