Skip to main content
All public REST endpoints are available at: 
https://api.yo-lead.com/v1
Every request must be signed with the HMAC headers described in Authentication.
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: 
{
  "data": {}
}
Error responses contain a numeric code and a human-readable message: 
{
  "code": 40001,
  "message": "Validation error"
}

​
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.