APIs
Ventryx exposes a unified REST API surface for every platform capability. Build, manage, and automate your infrastructure programmatically from any language or environment.
REST API fundamentals
All Ventryx APIs follow REST conventions — resources are addressed by URL, actions are mapped to HTTP verbs, and all responses are JSON. The API is versioned in the URL path to ensure backward compatibility as the platform evolves.
https://api.ventryx.io/v1
| Verb | Meaning |
|---|---|
GET | Retrieve a resource or list resources |
POST | Create a new resource |
PATCH | Partially update an existing resource |
DELETE | Remove a resource |
API versioning
The current stable version is v1. Ventryx commits to a minimum 12-month deprecation window before retiring any API version. You can also pin requests to a specific date-based version using the Ventryx-Version header:
Ventryx-Version: 2026-04-01
This ensures your integration continues to behave as it did on the day you built it, even as the API evolves.
Core API domains
| Domain | Base path | Description |
|---|---|---|
| Workflows | /v1/workflows | Create and manage automated workflows |
| Events | /v1/events | Emit and retrieve platform events |
| API Keys | /v1/api-keys | Manage authentication credentials |
| Webhooks | /v1/webhooks | Register outbound webhook endpoints |
| Analytics | /v1/analytics | Usage metrics and request telemetry |
| Organizations | /v1/orgs | Manage team members and org settings |
Request and response format
All request bodies must be JSON with a Content-Type: application/json header. Responses always include a top-level data key for successful results and an error key for failures.
{
"data": { "id": "wf_01HXYZ", "name": "My Workflow" },
"meta": { "total": 1, "page": 1, "per_page": 20 }
}
Pagination
List endpoints are paginated using page and per_page query parameters. Maximum page size is 100 items.
GET /v1/workflows?page=2&per_page=50