Skip to main content
All public REST endpoints are available at:
Every request must be signed with the HMAC headers described in Authentication. The company’s current plan must include Public API access. A correctly signed request returns 403 with code 40351 when API access is unavailable.
Endpoint-specific request fields, response fields, examples, and business rules are documented on each endpoint reference page.

​
Public surface

Only endpoints mounted under /v1 are part of the public API. Management endpoints used by the YoLead UI, including /integrations/*, are not public API endpoints.

​
Response format

Successful responses wrap the payload in data:
Error responses contain a numeric code and a human-readable message:

​
OpenAPI

The endpoint reference is rendered from the static OpenAPI file at openapi/public-api-v1.json. The backend implementation source for these endpoints is src/modules/publicApiV1.