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

Cordial Orchestrations API

The orchestrations API from Cordial — 4 operation(s) for orchestrations.

Cordial Orchestrations API is one of 25 APIs that Cordial publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 4 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://api.cordial.io/.

4 operations 4 paths 14 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.cordial.io/v2
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

Cordial Orchestrations API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth).

  • basicAuth — HTTP Basic Authentication. Works over HTTPS

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

orchestrations 4
GET
/v2/orchestrations/{orchestrationID}
Get a single orchestration
getOrchestration 1 param → 200404
GET
/v2/orchestrations
Get orchestrations
getOrchestrations 12 params → 200
POST
/v2/orchestrations/{orchestrationID}/trigger
Trigger an orchestration
triggerOrchestration 1 param body → 200422401
GET
/v2/orchestrations/{orchestrationID}/actions
Get list of orchestration actions
orchestrationActions 1 param → 200404401

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are ActionsOrchestrationSuccessResponse (5 properties), TriggerOrchestrationSuccessResponse (4 properties), Orchestration (4 properties), PodiumTriggerFailure (3 properties). Each schema is shown below with its type and property counts.

ContactAuto
object
1 property 1 required
PodiumTriggerFailure
object
3 properties 3 required
PodiumForPayload
object
2 properties 1 required
RecordNotFound
object
3 properties 2 required
PodiumTriggerResponseTriggeredValue
boolean
Indicates whether the orchestration was successfully triggered for the given payload.
TriggerOrchestrationRequestBody
object
3 properties 1 required
IdentifyBy
array
Specifies which identifier key in the request body should be used to look up the contact (e.g. cID, email, custID). Accepts a string or an array of strings in…
Orchestration
object
4 properties 4 required
TriggerOrchestrationSuccessResponse
object
4 properties 4 required
extVarsPodium
object
Using the extVars object, any number of external variables may be added. These values are then made available for all initial actions in the orchestration. For…
1 property
TriggerOrchestrationFailureResponse
object
3 properties 2 required
AuthenticationFailed
object
1 property 1 required
ActionsOrchestrationSuccessResponse
object
5 properties 5 required
PodiumTriggerSuccess
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cordial-orchestrations-api-openapi.yml Raw ↑

Other APIs Cordial publishes across the network.

Cordial MCP Server
Cordial account attributes API
Cordial account lists API
Cordial account monitor export API
Cordial Alerts API
Cordial analytics audiences API
Cordial analytics messages API
Cordial Audiencecount API
Cordial automation templates API
Cordial batch messages API
Cordial contact activities API
Cordial contact activity exports API
Where this information came from

This is an independent, third-party profile of Cordial Orchestrations 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.