Proposals/Confirmed Bookings

Fetch all events

Changed on

Returns a paginated list of events for the specified business. Results can be filtered by status, cancellation, date range, and text search.

Cancelled bookings are excluded by default. Cancellation is tracked separately from status -- a cancelled booking keeps the status it had when it was cancelled -- so it is filtered with canceled_status, not event_status. Pass canceled_status=show_canceled_only to list only cancelled bookings, or canceled_status=show_all to include them alongside everything else. The two filters combine: event_status=confirmed&canceled_status=show_canceled_only returns cancelled confirmed bookings.

The response includes meta.total_count (total matching events) and meta.per_page (results per page) to support pagination.

Syncing changes. Pass updated_since to fetch only events changed since your last sync, including changes to booking questions and questionnaire answers. Send a full ISO 8601 timestamp with an offset, such as 2026-10-12T15:00:00Z; a bare date means noon. Start each sync from the time your previous one began, less a minute, since changes take a few seconds to become searchable. Each event's updated_at shows when it last changed.

Use the include query parameter to sideload related resources (comma-separated). Available: event_bookings, proposal_alternatives, event_users, event_staff_members, event_staff_requests, contacts, notes, event_adjustments. The event's customers are sideloaded via event_users — there is no customer include.

On a proposal with alternatives, starting_balance, deposit_amount_due and balance_amount_due add every alternative together, which is not a price the client pays. Read each alternative's totals instead.

Required permission: assigned_event_read or unassigned_event_read

get/api/v1/events

Request

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

Query parameters

includestring

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

event_statusstring

Status filter. Does not filter cancellation -- use canceled_status for that.:

  • proposal_date_open
  • proposal_date_reserved
  • proposal_awaiting_review
  • awaiting_signature
  • confirmed
  • any_proposal
  • any_confirmed
  • any_unsigned
canceled_statusstring

Cancellation filter. Defaults to hide_canceled.

postponed_statusstring

Postponement filter. Defaults to hide_postponed.

expired_statusstring

Expired-proposal filter. Defaults to hide_expired.

past_or_futurestring

When filter. Defaults to both. Ignored when an event date range is supplied.

event_date_startstring

Event Date (Start)

event_date_endstring

Event Date (End)

booked_date_startstring

Booked Date (Start)

booked_date_endstring

Booked Date (End)

updated_sincestring

Only events changed at or after this time (ISO 8601, such as 2026-10-12T15:00:00Z)

search_textstring

Text Search

idinteger

Return only the event with this ID

brand_idinteger

Limit to events on this brand

client_idinteger

Limit to events for this client

staff_idinteger

Limit to events this staff member is assigned to

event_category_idinteger

Limit to events with a package in this service. Service ids come from GET /api/v1/event_categories.

proposal_viewedboolean

Proposals only. false returns proposals the client has never opened, true those they have. Combine with expired_status=show_all to include expired proposals.

awaiting_depositboolean

Only events whose deposit is unpaid

balance_outstandingboolean

Only events with a balance still owed

past_dueboolean

Only events with a past due payment

has_unselected_templatesboolean

Only events with a design template still unselected

has_pending_artworkboolean

Only events with artwork pending

has_unapproved_artworkboolean

Only events with artwork awaiting approval

unsubmitted_formsboolean

Only events with an unsubmitted form

no_staff_assignedboolean

Only events with no staff assigned

no_backdrop_assignedboolean

Only events with no backdrop assigned

sort_bystring

Sort Order. Defaults to automatic.

pageinteger

Page number for pagination (default: 1)

perinteger

Number of results per page (default: 10, max: 100)

Headers

Api-Keystring required

Your Integration Key

Response

events found

Changes

    • info

      added the new optional query request parameter event_category_id

    • info

      added the new optional query request parameter proposal_viewed