API Reference
Every WinFactor REST API v1 endpoint
Base URL: https://app.winfactor.app/api/v1 (substitute your deployment's domain). Authentication: API keys, except configuration-session endpoints which use capability URLs. Machine-readable spec: /openapi.yaml.
| Resource | Endpoints |
|---|---|
| Configuration sessions | GET /configuration-sessions/{token} · PUT /configuration-sessions/{token}/adjustments |
| Submissions | GET /submissions · GET /submissions/{id} · PATCH /submissions/{id} · POST /submissions/{id}/quotes |
| Quotes | GET /quotes · GET /quotes/{id} · PATCH /quotes/{id} · PUT /quotes/{id}/line-items · POST /quotes/{id}/send |
| Contacts | GET /contacts · POST /contacts · GET /contacts/{id} · PATCH /contacts/{id} |
| Leads | GET /leads · GET /leads/{id} |
| Templates | GET /templates · GET /templates/{id} · GET /templates/{id}/catalog |
| Events | GET /events · GET /events/{id} · POST /events/{id}/redeliver |
| Organization | GET /organization |
Conventions: list endpoints return { data, nextCursor } with ?limit= (≤100, default 50) and ?cursor=; errors use the standard envelope with a stable machine-readable error.code; all dimensions are integer millimetres; all timestamps are Unix milliseconds; monetary values are decimal numbers in the organization currency.
Rate limits: 60 req/min per IP before authentication, 120 req/min per API key, 120 req/min per IP on capability URLs. A 429 rate_limited response carries a Retry-After header in seconds — back off and retry.