How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Formance Orchestration API

Flows workflows, instances, and triggers (v2).

Formance Orchestration API is one of 8 APIs that Formance publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orchestration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 13 operations across 9 paths. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://{organization}.{environment}.formance.cloud.

13 operations 9 paths 0 schemas 2 DELETE7 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://{organization}.{environment}.formance.cloud/api/ledger
Authentication
OAuth 2.0
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Formance Orchestration API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 6 scopes. By default, every request must be authenticated.

  • oauth2 — OAuth2 client-credentials flow. Exchange a client id and secret at /api/auth/oauth/token for a Bearer access token, then send it as Authorization: Bearer .

Paths & Operations 13

Across 9 paths, the API surfaces 13 operations — 2 DELETE, 7 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Orchestration 13

Flows workflows, instances, and triggers (v2).

GET
/api/orchestration/v2/workflows
List registered workflows
listWorkflows → 200
POST
/api/orchestration/v2/workflows
Create a workflow
createWorkflow → 201
GET
/api/orchestration/v2/workflows/{flowId}
Get a workflow by id
getWorkflow 1 param → 200
DELETE
/api/orchestration/v2/workflows/{flowId}
Delete a workflow by id
deleteWorkflow 1 param → 204
POST
/api/orchestration/v2/workflows/{flowId}/instances
Run a workflow
runWorkflow 1 param → 201
GET
/api/orchestration/v2/instances
List workflow instances
listInstances → 200
GET
/api/orchestration/v2/instances/{instanceId}
Get a workflow instance by id
getInstance 1 param → 200
GET
/api/orchestration/v2/instances/{instanceId}/history
Get a workflow instance history by id
getInstanceHistory 1 param → 200
GET
/api/orchestration/v2/triggers
List triggers
listTriggers → 200
POST
/api/orchestration/v2/triggers
Create a trigger
createTrigger → 201
GET
/api/orchestration/v2/triggers/{triggerId}
Read a trigger
readTrigger 1 param → 200
DELETE
/api/orchestration/v2/triggers/{triggerId}
Delete a trigger
deleteTrigger 1 param → 204
POST
/api/orchestration/v2/events
Send an event to a running workflow instance
sendEvent → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

formance-orchestration-api-openapi.yml Raw ↑

Other APIs Formance publishes across the network.

Formance Auth API
Formance Ledger API
Formance Payments API
Formance Reconciliation API
Formance Search API
Formance Wallets API
Formance Webhooks API
Where this information came from

This is an independent, third-party profile of Formance Orchestration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.