Checklists

Fetch checklist items

Returns a paginated list of checklist items visible to the authenticated user. Results can be scoped to a single checklist, filtered by status, assignment, or full-text search, and sorted by due date, event date, or recency.

Visibility is determined automatically based on the authenticated user's role: admins see every item; staff see items on their personal checklist, items assigned to them, and items on event or franchise checklists they have view access to; customers see items on their event checklists where customer view is allowed.

The response includes meta.total_count and meta.per_page for pagination.

get/api/v1/checklist_items

Request

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

Query parameters

checklist_idinteger

Filter to items on a single checklist

checkable_typestring

Filter to items whose checklist is attached to this type:

  • Event
  • User
  • Franchise
checkable_idinteger

Filter to items whose checklist is attached to the record with this ID

filterstring

Status filter

assigned_filterstring

Assignment filter relative to the authenticated user

querystring

Full-text search across item titles and notes

sort_bystring

Sort order

show_proposalsboolean

Include items on proposal-status event checklists (default: true)

only_show_items_in_global_listboolean

Only return items flagged to appear in the global task list

pageinteger

Page number for pagination (default: 1)

perinteger

Number of results per page (default: 50)

Headers

Api-Keystring required

Your Integration Key

Response

checklist items found

Changes

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