Cooledge API
One REST API for your customers, jobs, quotes, invoices, bookings and leads. Authenticate with a key and make your first call in minutes.
$ curl https://app.cooledge.com.au/api/v1/me \
-H "X-Api-Key: ck_live_AB12CD_your_secret_here"Start here
The fastest path from zero to your first authenticated call.
Core concepts
How the Cooledge API paginates list endpoints with opaque cursors and how it reports errors. Covers the data and next_cursor envelope, the loop-until-null paging pattern and the RFC 7807 problem-details error format with its status codes.
How the Cooledge API limits request rate. Covers the default of 120 requests per minute per key, the 429 response with its Retry-After header, backoff guidance and the x-cooledge-request-id header on every response.
Webhooks
Subscribe to events and receive signed deliveries.
The index of every Cooledge webhook event. Covers the shared event envelope every delivery carries, at-least-once delivery with deduping on the event id and the full list of the thirteen event types you can subscribe to, each linking to its own payload page.
Subscribe to Cooledge events and receive signed HTTP deliveries. Covers managing subscriptions in the portal, the delivery request and its headers, verifying the X-Cooledge-Signature HMAC in Node, Python and PHP, deduping on the event id, retries with dead-lettering and replaying a delivery.
Integrations
Connect a GoHighLevel agency Location to Cooledge using the two-workflow Snapshot, so marketing-stage contacts and opportunities stay in sync with Cooledge jobs, quotes and invoices.
Connect Cooledge to thousands of apps with the planned Cooledge Zapier app. Covers the API-key Custom Auth connection, the eight REST Hook triggers and the seven write actions, how they map onto the v1 API and webhook events and how to join the private early-access release.
API reference
Browse every endpoint, schema and response in the interactive OpenAPI explorer.