Appearance

API reference

Workflows

Build, execute, schedule, and inspect the pipelines that power your automations.

This reference covers a selected set of supported Workflow operations. Additional platform capabilities may not be available through the public API.

Create Workflow​

Create a new workflow and configure its parameters.

Authorizations​

ApiToken

API key authentication

Type
API Key (header: x-api-token)

Request Body​

application/json

Unique identifier for the workflow

Display title of the workflow

Detailed description of the workflow's purpose

Configuration settings and API keys for the workflow

Input parameters for the workflow with default values or expressions

Output mappings for the workflow using expressions

Array of task definitions that make up the workflow

Current status of the workflow

Valid values"active""inactive"
Default"active"

Responses​

Workflow created successfully

application/json

Operation status

API playground
Build & test
POST/workflow

Playground​

Base URL
Authorization
Request body
Ready when you are

Send a request to see the response here.

Update Workflow​

Update an existing workflow by its ID.

Authorizations​

ApiToken

API key authentication

Type
API Key (header: x-api-token)

Parameters​

Path Parameters

id*

Unique ID of the workflow to update

Type
string
Required

Request Body​

application/json

Updated display title of the workflow

Updated description of the workflow's purpose

Updated status of the workflow

Valid values"active""inactive"

Updated configuration settings for the workflow

Updated input parameters for the workflow

Updated output mappings for the workflow

Responses​

Workflow updated successfully

application/json

Operation status

API playground
Build & test
PUT/workflow/{id}

Playground​

Base URL
Authorization
Variables
Key
Value
Request body
Ready when you are

Send a request to see the response here.

Delete Workflow​

Remove an existing workflow by its unique ID.

Authorizations​

ApiToken

API key authentication

Type
API Key (header: x-api-token)

Parameters​

Path Parameters

id*

Unique ID of the workflow to delete

Type
string
Required

Responses​

Workflow deleted successfully

application/json

Operation status

Success message

API playground
Build & test
DELETE/workflow/{id}

Playground​

Base URL
Authorization
Variables
Key
Value
Ready when you are

Send a request to see the response here.

Get Workflow by ID​

Retrieve a workflow by its unique ID.

Authorizations​

ApiToken

API key authentication

Type
API Key (header: x-api-token)

Parameters​

Path Parameters

id*

Unique ID of the workflow

Type
string
Required

Responses​

Workflow details

application/json

Operation status

API playground
Build & test
GET/workflow/id/{id}

Playground​

Base URL
Authorization
Variables
Key
Value
Ready when you are

Send a request to see the response here.

Get Workflow by Name​

Retrieve a workflow by its unique name.

Authorizations​

ApiToken

API key authentication

Type
API Key (header: x-api-token)

Parameters​

Path Parameters

name*

Unique name of the workflow

Type
string
Required

Responses​

Workflow details

application/json

Operation status

API playground
Build & test
GET/workflow/{name}

Playground​

Base URL
Authorization
Variables
Key
Value
Ready when you are

Send a request to see the response here.

Search Workflows​

Search for workflows using sort, filter and pagination.

Authorizations​

ApiToken

API key authentication

Type
API Key (header: x-api-token)

Request Body​

application/json

Query filters object

Default{}

Array containing field name and sort direction

Default"name"1

Page number (starts from 1)

Default1

Number of items per page

Default10

Responses​

Successful operation

application/json

Array of matching workflows

Total number of matching workflows

Operation status

API playground
Build & test
POST/workflow/search

Playground​

Base URL
Authorization
Request body
Ready when you are

Send a request to see the response here.

Execute Workflow by ID​

Trigger a workflow run by its unique ID.

Authorizations​

ApiToken

API key authentication

Type
API Key (header: x-api-token)

Parameters​

Path Parameters

id*

Unique ID of the workflow to execute

Type
string
Required

Request Body​

application/json

Whether to execute the workflow immediately

Defaultfalse

Input parameters for the workflow execution

Additional context data for the workflow execution

Responses​

Workflow execution result or status

application/json

HTTP status code

Execution result data

API playground
Build & test
POST/workflow/executor/id/{id}

Playground​

Base URL
Authorization
Variables
Key
Value
Request body
Ready when you are

Send a request to see the response here.

Execute Workflow by Name​

Trigger a workflow run by its unique name.

Authorizations​

ApiToken

API key authentication

Type
API Key (header: x-api-token)

Parameters​

Path Parameters

name*

Unique name of the workflow to execute

Type
string
Required

Request Body​

application/json

Whether to execute the workflow immediately

Defaultfalse

Input parameters for the workflow execution

Additional context data for the workflow execution

Responses​

Workflow execution result or status

application/json

HTTP status code

Execution result data

API playground
Build & test
POST/workflow/executor/{name}

Playground​

Base URL
Authorization
Variables
Key
Value
Request body
Ready when you are

Send a request to see the response here.

Execute Workflow by Name (Immediate)​

Execute a workflow immediately by its name.

Authorizations​

ApiToken

API key authentication

Type
API Key (header: x-api-token)

Parameters​

Path Parameters

name*

Unique name of the workflow to execute

Type
string
Required

Request Body​

application/json

Context data for the workflow execution

Responses​

Workflow execution result

application/json

Execution result data

Operation status

API playground
Build & test
POST/workflow/execute/{name}

Playground​

Base URL
Authorization
Variables
Key
Value
Request body
Ready when you are

Send a request to see the response here.

Get Scheduled Workflow by Run ID​

Retrieve data from a scheduled workflow execution.

Authorizations​

ApiToken

API key authentication

Type
API Key (header: x-api-token)

Parameters​

Path Parameters

workflow_run_id*

Unique run ID of the scheduled workflow execution

Type
string
Required

Responses​

Workflow schedule details

application/json

Operation status

API playground
Build & test
GET/workflow/schedule/{workflow_run_id}

Playground​

Base URL
Authorization
Variables
Key
Value
Ready when you are

Send a request to see the response here.

© 2026 Machina Sports · machina.gg