Leads

Fetch all lead bookings

Returns a paginated list of bookings attached to leads (potential customers who have not yet been converted to a confirmed event). Results can be filtered by date range and brand.

Use the include query parameter to sideload related resources (comma-separated). Available: lead_add_ons, lead_extras, lead_booking_extra_categories, lead_booking_extra_categories.lead_extras, photobooth_background.

Required permission: lead_read

get/api/v1/lead_bookings

Request

  • Base URL: https://api.checkcherry.com
  • URL: https://api.checkcherry.com/api/v1/lead_bookings
  • Auth: none declared. Required headers: Api-Key

Query parameters

includestring

Related resources to sideload, comma-separated. The description lists what is available.

event_date_startstring

Event Date (Start)

event_date_endstring

Event Date (End)

pageinteger

Page number for pagination (default: 1)

perinteger

Number of results per page

Headers

Api-Keystring required

Your Integration Key

Response

lead bookings found

Changes

No recorded changes to this operation across all 2 revisions of this API.