Skip to content

API Documentation

Complete reference for the ValuePact REST API. Use these guides to authenticate, handle errors, paginate results, and integrate programmatically.

Who this is for

Developer Admin

API guides

Guide What you'll learn
API Overview Base URL, request format, status codes, idempotency
Authentication JWT tokens, SSO, MFA, API keys, permission claims
Rate Limits Tiered limits, burst behavior, backoff strategies
Errors Error codes, retry behavior, request IDs
Pagination Offset and cursor pagination, sorting, filtering

Endpoint reference

Domain Description
Initiatives Strategic programs
Business Cases Value arguments and deliverables
Benefits Benefit tracking
Stakeholders Stakeholder management
Dashboards Dashboard data
Analytics Analytics and insights
Users User profiles
Roles Role and permission management
Integrations Connector configuration
Webhooks Webhook subscriptions

Interactive documentation

The Generated API Docs renders the canonical OpenAPI specification with interactive Swagger UI. You can execute requests directly from the browser.

SDKs and tools

  • OpenAPI spec: /openapi.json on any service
  • Postman: Import the OpenAPI spec
  • Swagger UI: /docs on each service

Getting help