OpenAPI Reference

The Skunivo public API contract is published with this portal:

/openapi/skunivo-public-openapi.json

This interactive reference loads that public JSON file directly. It contains only API key authenticated endpoints intended for developers and integrators. It is a portal-owned copy of the public contract, so consumers do not need access to the private API repository or internal /api-docs.

You can also browse the native API reference generated from the same contract or download the OpenAPI JSON.

Integration Rule

Build SDKs, tests and connector adapters against the OpenAPI contract and public organization API. Do not depend on:

• Internal admin routes.
• Human session cookies.
• Private customer panel routes.
• Implementation details from backend controllers.

Public Contract

Use the public contract for generated clients, integration tests and connector adapters. The internal API documentation used by Skunivo engineering can include additional private routes and is not exposed in production.

Contract Consumers

The public contract is used by:

• The local Skunivo Node.js SDK type generation.
• Public integration tests and examples.
• Future connector adapters.
• Non-JavaScript clients generated by integrators.

If the contract and prose documentation disagree, treat the public OpenAPI contract as the source of truth and update the documentation.

Interactive Reference

Use Try it out only with test credentials and the test environment while validating an integration.

Loading OpenAPI reference…