Checklists

Fetch checklists

Returns the checklists visible to the authenticated user. Pass an event_id to limit results to checklists attached to a specific event (booking or proposal); omit it to get every checklist the user can see across the franchise (event checklists, the user's personal staff checklist, and any franchise-level checklists).

Visibility is determined automatically based on the authenticated user's role: admins see every checklist; staff see their personal checklist plus event checklists they're assigned to or that allow staff view; customers see their event checklists where customer view is allowed.

Each checklist includes a complete_count (number of checked items) and count (total items) to support progress displays without a separate request.

get/api/v1/checklists

Request

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

Query parameters

event_idinteger

Filter checklists by event ID

pageinteger

Page number (default: 1)

perinteger

Results per page (default: 50)

Headers

Api-Keystring required

Your Integration Key

Response

checklists found

Changes

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