Fetch all leads
Returns a paginated list of leads for the specified business. Results can be filtered by email address for exact matching, or by a text query that performs a full-text search across lead names, email, phone, venue, and notes.
Each lead includes booking details (event date, start/end time, length, package name, service name) from its primary lead booking, flattened directly into the lead attributes.
Use the include query parameter to sideload related resources (comma-separated). Available: lead_bookings.
The response includes meta.total_count (total matching leads) and meta.per_page (results per page) to support pagination.
Required permission: lead_read
Request
- Base URL: https://api.checkcherry.com
- URL: https://api.checkcherry.com/api/v1/leads
- Auth: none declared. Required headers: Api-Key
Query parameters
Related resources to sideload, comma-separated. The description lists what is available.
Filter leads by exact email address match
Full-text search across lead name, email, phone, venue, and notes
Page number for pagination (default: 1)
Number of results per page (default: 25)
Headers
Your Integration Key
Response
leads found
Changes
No recorded changes to this operation across all 2 revisions of this API.