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 Supplements API

The supplements API from Cordial — 12 operation(s) for supplements.

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

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

This API exposes 24 operations across 12 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

24 operations 12 paths 27 schemas 4 DELETE8 GET6 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

  • basicAuth — HTTP Basic Authentication. Works over HTTPS

Paths & Operations 24

Across 12 paths, the API surfaces 24 operations — 4 DELETE, 8 GET, 6 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

supplements 24
GET
/v1/supplements/{key}
Get a single supplement
getsupplement 2 params → 200422
PUT
/v1/supplements/{key}
Update a single supplement
updatesupplement 1 param body → 200422
DELETE
/v1/supplements/{key}
Delete supplement
deletesupplements 1 param → 400
POST
/v1/supplements
Add a new supplement
addsupplement body → 200
GET
/v1/supplements
Get supplements
getsupplements 2 params → 200422
PUT
/v1/supplements/{supplement}/clear
Clear a single supplement
clearsupplement 1 param → 200422
GET
/v1/supplements/{supplement}/records
Get records from a supplement
getsupplementrecords 6 params → 200422
POST
/v1/supplements/{supplement}/records
Add records to a supplement
addsupplementrecord 1 param body → 200422
GET
/v1/supplements/{supplement}/records/{id}
Get a single supplement record
getsupplementrecord 2 params → 200422
PUT
/v1/supplements/{supplement}/records/{id}
Update a single supplement record
updatesupplementrecord 2 params body → 200422
DELETE
/v1/supplements/{supplement}/records/{id}
Delete a single supplement record
deletesupplementrecord 2 params → 200422
POST
/v1/supplements/{supplement}/imports
Add a new job
importsupplementrecords 1 param body → 200422
GET
/v2/supplements/{key}
Get a single supplement
getsupplement 2 params → 200404
PUT
/v2/supplements/{key}
Update a single supplement
updatesupplement 1 param body → 200422
DELETE
/v2/supplements/{key}
Delete supplement
deletesupplements 1 param → 200422
POST
/v2/supplements
Add a supplement
addsupplement body → 200422
GET
/v2/supplements
Get supplements
getsupplements 2 params → 200404
PUT
/v2/supplements/{supplement}/clear
Clear a single supplement
clearsupplement 1 param → 200404
GET
/v2/supplements/{supplement}/records
Get records from a supplement
getsupplementrecords 7 params → 200404422
POST
/v2/supplements/{supplement}/records
Add records to a supplement
addsupplementrecord 1 param body → 201422
GET
/v2/supplements/{supplement}/records/{id}
Get a single supplement record
getsupplementrecord 2 params → 200404422
PUT
/v2/supplements/{supplement}/records/{id}
Update a single supplement record
updatesupplementrecord 2 params body → 200400
DELETE
/v2/supplements/{supplement}/records/{id}
Delete a single supplement record
deletesupplementrecord 2 params → 200404422
POST
/v2/supplements/{supplement}/imports
Create a supplement record import job
importsupplementrecords 1 param body → 201406422

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are SourceObject (18 properties), SourceSup (11 properties), SupplementImportResource (9 properties), JobSup (9 properties). Each schema is shown below with its type and property counts.

SupplementSup
object
3 properties 2 required
IndexesSup_2
object
2 properties 2 required
SupplementResponse
object
7 properties 1 required
SupplementUpdateSup_2
object
4 properties 2 required
SupplementRecordPostResponse
object
3 properties 2 required
SupplementValidationError
object
4 properties 3 required
SupplementDoesntExist
object
3 properties 2 required
SupplementShowSup
object
5 properties 1 required
RecordSupplementResponse
object
2 properties 1 required
validationSupplementPutErrors
object
1 property 1 required
SupplementUpdateError
object
4 properties 2 required
SupplementImportConfigError
object
3 properties 3 required
SuccessOperation
object
1 property 1 required
RecordNotFound
object
3 properties 2 required
RecordSup
object
1 property
SourceObject
object
18 properties 3 required
validationSupplementErrors
object
1 property 1 required
SupplementUpdateSup
object
2 properties 2 required
SupplementRecordPost
object
Additional parameters or fields can be added to the JSON based on your data. This includes the indexed fields previously defined for the supplement and any fie…
2 properties 1 required
SupplementRecordCreationSuccess
object
2 properties 2 required
SupplementRecordPutResponse
object
3 properties 2 required
SupplementImportConfigSuccess
object
1 property 1 required
JobSup
object
9 properties 1 required
IndexesSup
object
2 properties 2 required
SupplementImportResource
object
9 properties 1 required
SourceSup
object
11 properties 3 required
SupplementSup_2
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cordial-supplements-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 Supplements 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.