Skip to main content

Using the API

Everything the web interface does, it does through the Workflows REST API — and that API is available to you as well. Use it to start runs from a build pipeline, poll for results from another system, or manage workflows without opening a browser.

The complete, generated reference for every endpoint is in the API reference.

The base URL​

The API lives on the same host as the web application, under /api/v1. If you reach Workflows at https://workflows.example.com, then the API is at https://workflows.example.com/api/v1.

Authentication​

Every endpoint requires a bearer token issued for your organization. Send it in the Authorization header:

Authorization: Bearer <your-token>

Requests without a valid token are rejected. A token carries the permissions of the account it belongs to, and it is scoped to that account's organization — the API cannot reach data belonging to another one.

Treat tokens as credentials: keep them out of source control, out of URLs, and out of logs.

A first request​

Confirm your setup works before building anything on it:

curl -H "Authorization: Bearer $WORKFLOWS_TOKEN" \
  https://workflows.example.com/api/v1/workflows

That returns the workflows in your organization. A 401 means the token is missing, malformed, or expired.

What the API covers​

The endpoints are grouped by area:

AreaWhat it covers
WorkflowsList, inspect, create, update, publish.
Workflow executionsStart runs, check status, retrieve results.
NodesThe catalog of available node types.
Workflow templatesReusable starting graphs.
Organization connectionsDatabases, FossID Knowledge Base, and Workbench connections.
Users and settingsOrganization membership and preferences.
ReviewsApproval gates awaiting a decision.
StatisticsThe figures behind the dashboard.

Each endpoint's parameters, request body, and responses are documented in the API reference, which also lets you try requests directly against an instance.