Developer Platform
API Overview
How the Vestval API is designed — resource-oriented, predictable and built for long-lived integrations.
Overview
The Vestval API is designed to be predictable and durable. It is resource-oriented, uses conventional HTTP verbs and status codes, and returns structured JSON so integrations behave consistently across every product in the ecosystem.
This overview is conceptual: it describes the principles and shape of the platform API so teams can plan integrations. Concrete endpoint references are provisioned per engagement as products are enabled for your organization.
What this covers
Resource-oriented
Entities are modeled as resources with consistent, predictable URLs and representations.
Conventional HTTP
Standard verbs and status codes so behavior is obvious to any developer.
Structured errors
Errors return machine-readable codes and human-readable messages for reliable handling.
Pagination & filtering
Large collections are paginated with stable cursors and consistent filtering semantics.
Idempotency
Write operations support idempotency keys so retries never double-apply.
Rate limiting
Documented limits with clear headers so clients can back off gracefully.
FAQ
Frequently asked
- The platform API is JSON over HTTPS, resource-oriented, using conventional HTTP verbs and status codes.