API Endpoints¶

This section provides detailed reference documentation for every ValuePact API endpoint group.

Who this is for¶

Developer

Group	Description	Key Operations
Initiatives	Strategic programs and their lifecycle	CRUD, status transitions, archive
Business Cases	Packaged value arguments and deliverables	Create, approve, export, version
Benefits	Expected and realized benefits tracking	Track, update, reconcile, report
Stakeholders	People and roles mapped to initiatives	Manage, map influence, engagement
Dashboards	Dashboard data and report configurations	Query, configure, export
Analytics	Aggregated analytics and insights	ROI, forecast, trend, benchmark
Users	User profiles and organization membership	List, update, deactivate
Roles	Roles and permission assignments	List, assign, query permissions
Integrations	Third-party connector configuration	Connect, configure, monitor
Webhooks	Webhook subscription management	Register, list, update, delete

Every endpoint group follows these conventions:

Base path: /v1/{group}
List: GET /v1/{group} — supports pagination, filtering, sorting
Create: POST /v1/{group} — returns 201 with the created resource
Get: GET /v1/{group}/{id} — returns 200 or 404
Update: PUT /v1/{group}/{id} or PATCH /v1/{group}/{id} — full or partial update
Delete: DELETE /v1/{group}/{id} — returns 204

For complete request and response schemas, refer to the Generated API Docs which renders the canonical OpenAPI specification interactively.

All endpoints return the standard error format. Common errors per group:

Group	Common errors
Initiatives	`VALIDATION_ERROR` (invalid status transition), `NOT_FOUND`
Business Cases	`CONFLICT` (already approved), `AUTHORIZATION_ERROR`
Benefits	`INVALID_PARAMETER` (date range), `NOT_FOUND`
Stakeholders	`ALREADY_EXISTS` (duplicate email), `VALIDATION_ERROR`
Analytics	`RATE_LIMIT_EXCEEDED`, `SERVICE_UNAVAILABLE`

See Rate Limits for tiered limits. Analytics endpoints have lower limits due to computation cost.