RunWhen workflow-v4 API
The workflow-v4 API from RunWhen — 3 operation(s) for workflow-v4.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/runwhen-workflow-v4-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API 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 Specification
openapi: 3.2.0
info:
title: papi alert-query-proxy Workflow V4 API
description: RunWhen Platform API
version: 2.0.0
servers:
- url: https://papi.beta.runwhen.com
description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: workflow-v4
paths:
/api/v4/workspaces/{workspace_name}/workflows:
get:
tags:
- workflow-v4
summary: List Workflows
operationId: list_workflows_api_v4_workspaces__workspace_name__workflows_get
parameters:
- name: workspace_name
in: path
required: true
schema:
type: string
title: Workspace Name
- name: limit
in: query
required: false
schema:
type: integer
maximum: 1000
minimum: 1
description: Maximum number of results
default: 100
title: Limit
description: Maximum number of results
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: Number of results to skip
default: 0
title: Offset
description: Number of results to skip
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowListResponseV4'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- BearerAuth: []
/api/v4/workspaces/{workspace_name}/workflows/{workflow_name}:
get:
tags:
- workflow-v4
summary: Get Workflow
operationId: get_workflow_api_v4_workspaces__workspace_name__workflows__workflow_name__get
parameters:
- name: workspace_name
in: path
required: true
schema:
type: string
title: Workspace Name
- name: workflow_name
in: path
required: true
schema:
type: string
title: Workflow Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowResponseV4'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- BearerAuth: []
delete:
tags:
- workflow-v4
summary: Soft-delete a Workflow (V4, short-name URL)
description: Soft-delete a Workflow by its short name (mirrors the v4 GET URL).
operationId: delete_workflow_api_v4_workspaces__workspace_name__workflows__workflow_name__delete
parameters:
- name: workspace_name
in: path
required: true
schema:
type: string
title: Workspace Name
- name: workflow_name
in: path
required: true
schema:
type: string
title: Workflow Name
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- BearerAuth: []
/api/v4/workspaces/{workspace_name}/workflows/sync-typed:
post:
tags:
- workflow-v4
summary: Upsert a Workflow (V4 typed payload)
operationId: sync_workflow_typed_api_v4_workspaces__workspace_name__workflows_sync_typed_post
parameters:
- name: workspace_name
in: path
required: true
schema:
type: string
title: Workspace Name
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowSyncRequestV4'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- BearerAuth: []
components:
schemas:
WorkflowResponseV4:
properties:
id:
type: integer
title: Id
name:
type: string
title: Name
description: 'Full workflow name: workspace--workflow-short-name'
shortName:
type: string
title: Shortname
workspaceId:
type: integer
title: Workspaceid
definition:
additionalProperties: true
type: object
title: Definition
createdAt:
type: string
format: date-time
title: Createdat
modifiedAt:
type: string
format: date-time
title: Modifiedat
type: object
required:
- id
- name
- shortName
- workspaceId
- createdAt
- modifiedAt
title: WorkflowResponseV4
description: Flat-shape Workflow detail response.
WorkflowSyncRequestV4:
properties:
payload:
$ref: '#/components/schemas/WorkflowPayloadV4'
lastSyncedAt:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Lastsyncedat
additionalProperties: false
type: object
required:
- payload
title: WorkflowSyncRequestV4
description: 'Body of POST /api/v4/workspaces/{ws}/workflows/sync-typed.
``modified_by`` is not accepted: the server derives it from the JWT via
``get_effective_modifier``. Unknown keys (including ``modified_by``)
raise 422 because ``V4RequestModel`` sets ``extra="forbid"``.'
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
WorkflowPayloadV4:
properties:
name:
type: string
title: Name
definition:
additionalProperties: true
type: object
title: Definition
additionalProperties: false
type: object
required:
- name
title: WorkflowPayloadV4
description: Writable subset of Workflow (the body of a sync upsert).
WorkflowListResponseV4:
properties:
results:
items:
$ref: '#/components/schemas/WorkflowResponseV4'
type: array
title: Results
count:
type: integer
title: Count
next:
anyOf:
- type: string
- type: 'null'
title: Next
previous:
anyOf:
- type: string
- type: 'null'
title: Previous
type: object
required:
- results
- count
title: WorkflowListResponseV4
description: Paginated list of Workflows.
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
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: JWT access token from /api/v3/token/ or Auth0 login