Home - ChecQR Operational Recordkeeping

Showing 25 of 34 from the live probe.

• Get Current Time

  Returns the current date, time, and Unix timestamp in milliseconds. Call this whenever you are unsure of the current date or time, especially before calculating timestamp ranges for period queries.

• List Organisations

  Returns the name and ID of every ChecQR organisation this user has access to, and which one is currently active. Always call this first — it tells you the organisation name you are working in. If the user has more than one organisation, also call select_organisation before using any other tools.

• Select Organisation

  Selects which organisation to work with. Required when the user has access to more than one.

• List Checklists

  Returns all checklists for the organisation, including inactive ones.

• Create Checklist

  Creates a new checklist. It will be active by default with an ad-hoc schedule.

• Update Checklist

  Renames a checklist or changes its active status.

• Delete Checklist

  Permanently removes a checklist and all its questions.

• Get Checklist Schedule

  Returns the schedule for a checklist including all check windows with their IDs. Call this before making any schedule changes to get the current window_ids.

• Set Schedule Adhoc

  Removes all check windows and sets the checklist to ad-hoc (no fixed schedule).

• Add Check Window

  Adds a check window to a checklist's schedule. If the checklist is currently ad-hoc it will become scheduled. days: list of full day names e.g. ['Monday', 'Wednesday']. start/end: 24-hour HH:MM strings e.g. '09:00', '17:30'.

• Update Check Window

  Updates an existing check window. Call get_checklist_schedule first to get the window_id. Only the fields you provide are changed.

• Delete Check Window

  Deletes a check window. Call get_checklist_schedule first to get the window_id. If it is the last window the checklist becomes ad-hoc.

• Get Checklist Questions

  Returns the questions for a specific checklist, in order.

• Add Question

  Adds a new question to a checklist. Supported formats: Text, YesOrNo, Number, SelectOne, SelectMultiple, Photo, Date, DateAndTime, Time, Signature, Location, MultipleTextFields, MultipleFields. SelectOne/SelectMultiple require either options (min 2 strings) or options_from_list_id — the id of an uploaded option list (see list_option_lists/create_option_list) — for very large option sets. Provide one or the other, never both. MultipleTextFields requires field_names (list of label strings, min 1).

• Update Question

  Updates fields on an existing question. Only the fields you provide are changed. Use get_checklist_questions first to see the question's current state. Provide either options or options_from_list_id, never both.

• Delete Question

  Soft-deletes a question from a checklist.

• Add Answer Action

  Adds a trigger to a question: either a follow-on question, or an alert. condition_type must match the question format: 'equals' — YesOrNo (equals_value must be 'Yes' or 'No'), SelectOne/SelectMultiple (equals_value must be one of the question's options), Text (any string). 'range' — Number only. Triggers when the answer is outside the specified bounds. below_value triggers when the answer is below that number; above_value triggers when the answer is above that number. At least one of below_value

• Delete Answer Action

  Removes a follow-on trigger from a question. Also deletes all follow-on questions attached to that trigger (and their descendants). Use get_checklist_questions to find action_ids.

• List Option Lists

  Lists all uploaded option lists for the organisation (id, display_name, row_count). Use options_from_list_id with add_question/update_question to use one of these lists as the answer options for a SelectOne/SelectMultiple question, instead of typing out options — lists are meant for option sets too large to type or display in full (they can run to millions of rows), so look them up here rather than asking the user to paste every value.

• Get Option List Details

  Returns id, display_name, and row_count for a single uploaded option list.

• Search Option List

  Searches an uploaded option list for rows matching search_text (matches against either the value or display_name, case-insensitive substring/prefix match). Returns up to `limit` rows (default 10, max 50) plus whether the results were truncated. There is no way to fetch an entire list in one call — lists can run to millions of rows, so results are always found via search, never bulk-exported. Omit search_text to browse the first page of the list.

• Create Option List

  Creates a new uploaded option list from rows you provide inline — there is no file upload in this connector, so gather the values yourself (e.g. from a spreadsheet the user pasted into the conversation) and pass them as structured rows. Each row is {value, display_name}; display_name is optional and defaults to value. value must be unique within the list, and so must display_name. Returns the new list's id — pass it as options_from_list_id when calling add_question/update_question on a SelectOne

• Update Option List

  Renames an uploaded option list and/or replaces its rows entirely. Provide display_name and/or rows — whichever you provide is changed; if rows is provided it replaces every existing row (not a merge).

• Delete Option List

  Soft-deletes an uploaded option list. Fails if any active question still uses it as options_from_list_id — remove that reference first.

• List Question Conditions

  Lists all question conditions for a checklist. A question condition hides one or more questions (question_ids) until every one of its rules is satisfied (rules are AND'd together). Two rule types exist: answerToAnotherQuestion (e.g. only show extreme-weather questions if 'Is it snowing?' was answered Yes) and checklistTimeWindow (e.g. only show a question in the morning check window). This is a different mechanism from add_answer_action's follow-on triggers — those attach directly to one questio