Public API

CPQ Consultant Public API

These are the public JSON endpoints and discovery documents exposed for agents, automation, and lightweight integrations.

Authentication

The public endpoints below are anonymous. Internal webhook routes are intentionally excluded from this catalog and do not publish OAuth or OIDC discovery metadata because they are not third-party, agent-facing interfaces.

Endpoints

Every endpoint below is also described in the OpenAPI document and referenced from the API catalog.

GET/api/health

Health check

Returns a lightweight health response for the published public API surface.

Auth

None

Request

This endpoint does not require a request body.

Example Response

{
  "status": "ok",
  "service": "cpq-consultant-public-api",
  "timestamp": "2026-04-20T12:00:00.000Z"
}
POST/api/contact

Contact form submission

Sends a project inquiry to the CPQ Consultant team and triggers a confirmation email.

Auth

None

Example Request

{
  "name": "Jordan Lee",
  "email": "jordan@acme.com",
  "company": "Acme Industrial",
  "phone": "+1-901-401-0277",
  "platform": "Salesforce CPQ",
  "message": "We need help rescuing a stalled CPQ rollout before Q3."
}

Example Response

{
  "success": true,
  "id": "re_1234567890"
}
POST/api/subscribe

Checklist email request

Adds an email address to the checklist delivery flow and sends the CPQ implementation checklist.

Auth

None

Example Request

{
  "email": "ops@acme.com"
}

Example Response

{
  "success": true
}
POST/api/onboarding-questionnaire

CPQ onboarding questionnaire

Submits the onboarding intake form used to scope CPQ discovery and implementation work.

Auth

None

Example Request

{
  "email": "ops@acme.com",
  "companyName": "Acme Industrial",
  "currentCRM": "Salesforce",
  "currentCPQ": "Manual process",
  "implementationObjectives": "Reduce quote turnaround from three days to same day."
}

Example Response

{
  "success": true
}