API Documentation

This section contains documentation for external API endpoints used by partners and integrations.


Available APIs

Lead Creation API

Create leads from external partner systems. The endpoint creates a quote, establishes a user account, and returns a magic login URL for immediate user access.

Endpoint: POST /api/{partner}/lead/create

Sections:

  • Overview - Introduction and implementation notes
  • Authentication - How to authenticate requests
  • Request Format - Payload schema and validation rules
  • Response Format - Success and error response structures
  • Examples - Valid request/response examples
  • Error Handling - Invalid use cases and error responses