add_answer_action
ClaudeAdds a trigger to a question: either a follow-on question, or an alert. Not available for PhotoAndReading questions: alerts for asset readings are set on the asset type's properties (update_asset_type) and copied onto the question automatically. 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 or above_value must be provided. 'date' — Date/DateAndTime only; requires date_unit (days/months/years), date_direction (past/future), date_number (1-31), and date_condition (moreThan/lessThan/moreThanOrEqualTo/lessThanOrEqualTo). action_type controls what happens when the condition is met: 'followUpQuestion' (default) shows a follow-on question — the returned action_id is then passed as parent_action_id when calling add_question. Any other value must be one of this organisation's configured alert type IDs (e.g. 'majorAlert', 'minorAlert') — call get_organisation_details first and use the id from its alert_types list; the set of alert types, their ids, and display names are organisation-specific and configurable, so never guess or hardcode one. This trigger only fires from THIS question's own answer, immediately. If the condition should instead depend on an earlier, non-adjacent question, a check window/shift, or multiple combined rules, use create_question_condition instead — that is a separate, checklist-level mechanism, not an alternate way to configure this one.
add_check_window
ClaudeAdds 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'.
add_process_report
ClaudeAdds a reporting option to a process. A process report fills a spreadsheet with the results of chosen checklists; set which checklists and where with update_process_report. Uploading the report's spreadsheet template is done in the dashboard.
add_question
ClaudeAdds a new question to a checklist. Supported formats: Text, YesOrNo, Number, SelectOne, SelectMultiple, Photo, Selfie, Date, DateAndTime, Time, Signature, Location, MultipleTextFields, MultipleFields, PhotoAndReading. Selfie is a Photo question taken with the front camera, only available to organisations that use the new mobile app. PhotoAndReading requires asset_id (from list_assets) and takes no question_text: the user scans that asset's QR code, photographs its display and enters the reading. It also takes asset_property_id, the asset type property being read (from get_asset_type); it can be left out when the asset type has exactly one property. Its alerts are the alerts on that asset type's properties (see get_asset_type / update_asset_type), copied onto the question automatically; it takes no answer actions. 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). MultipleFields requires fields (list of {text, format} objects, min 2; format must be one of Date, DateAndTime, Number, Text, Time, YesOrNo). Date/DateAndTime require date_options (Past, Future, or PastAndFuture). Number supports optional measurement_unit (e.g. '°C', 'kg', '%') and decimal_places ('0', '1', '2', or '' for any). If order is omitted the question is added at the end; see the order parameter before setting it. To add a follow-on question, provide parent_question_id and parent_action_id (both required together) — get these from get_checklist_questions.
add_user_to_group
ClaudeAdds an organisation user to a group. Get user_id from list_organisation_users.
copy_process
ClaudeCopies a process under a new name. Every checklist used by the process is also copied (with its questions and question conditions), named '<checklist> for <new name> process', and the copy uses those new checklists.
create_asset_type
ClaudeCreates an asset type, the same as Add asset type in the dashboard. Returns the new asset type. The exact-match lookup field can only be set up in the dashboard.
create_checklist
ClaudeCreates a new checklist. It will be active by default with an ad-hoc schedule.
create_group
ClaudeCreates a user group. Names must be unique in the organisation.
create_option_list
ClaudeCreates 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/SelectMultiple question.
create_process
ClaudeCreates a process. A process needs at least one stage, and every non-ongoing stage needs at least one checklist (create checklists first with create_checklist if needed). Parameters are values a user enters when starting the process; a stage with 'parameter' behaviour routes on one of them. Stages run in array order unless next_stage, next_steps or matches send the process elsewhere.
create_question_condition
ClaudeCreates a question condition on a checklist. question_ids are the questions that only become visible once every rule is met. Each rule is one of: {rule_type: 'answerToAnotherQuestion', question_id, operator, answer_value} — question_id must be a Text, SelectOne, YesOrNo, PhotoAndReading, or Number question on this checklist (call get_checklist_questions to find one and its format/options); operator is 'equals', 'notEquals', 'lessThan', or 'greaterThan' ('lessThan'/'greaterThan' only valid for Number/PhotoAndReading); answer_value must be 'Yes'/'No' for YesOrNo questions, or one of the question's options for SelectOne. {rule_type: 'checklistTimeWindow', check_window_ids} — restricts the condition to specific check windows (call get_checklist_schedule to find window_ids). This is a checklist-level mechanism, distinct from add_answer_action's follow-on triggers: use it when the condition references an earlier, non-adjacent question, a check window/shift, or combines multiple rules. For a simple case — one question's own answer immediately revealing the very next question, or raising an alert — use add_answer_action instead; it is not an alternate way to configure this tool.
delete_answer_action
ClaudeRemoves 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.
delete_asset
ClaudeDeletes an asset (asset_id from list_assets). Refused while any checklist uses it. Its stickers stop working.
delete_asset_type
ClaudeDeletes an asset type. Refused while any asset uses it.
delete_check_window
ClaudeDeletes a check window. Call get_checklist_schedule first to get the window_id. If it is the last window the checklist becomes ad-hoc.
delete_checklist
ClaudePermanently removes a checklist and all its questions.
delete_group
ClaudeDeletes a user group. The default Owners and Admins groups cannot be deleted.
delete_option_list
ClaudeSoft-deletes an uploaded option list. Fails if any active question still uses it as options_from_list_id — remove that reference first.
delete_process
ClaudeDeletes a process. Its checklists are not deleted.
delete_process_report
ClaudeDeletes a reporting option from a process.
delete_question
ClaudeSoft-deletes a question from a checklist.
delete_question_condition
ClaudeDeletes a question condition. The questions it referenced are not deleted themselves — they simply stop being conditional.
duplicate_asset_sticker
ClaudeReturns a download URL for a PDF of one existing asset sticker (for example SNB01: sticker pack ID SNB0 followed by the sticker number), drawn exactly as on the printed sticker sheet, including the CutContour cut line. The sticker must belong to this organisation.
enable_process_stage_notification
ClaudeTurns on the organisation's 'process stage entered' email notification and adds the given groups to its recipients. Without this, a stage's notify_group_ids send nothing. create_process/update_process list affected groups in notify_groups_not_enabled. update_notification_setting turns it off again; the event then stays marked as saved in get_organisation_details.
generate_checklist_qr_code
ClaudeGenerates a printable PDF with a QR code that starts a checklist and returns its download URL. For a checklist linked to an asset type, the PDF has one QR code per asset plus one for the checklist itself.
generate_process_qr_code
ClaudeGenerates a printable PDF with a quick start QR code for a process and returns its download URL.
get_asset_stickers
ClaudeLists every asset sticker in this organisation's sticker packs (assets not deleted), with its pack, asset type, and the checklists it is used on.
get_asset_type
ClaudeReturns an asset type's name, whether it can be assigned to a user, its fields, and its properties with their alerts. Asset readings take their alerts from here, not from the question.
get_checklist_period
ClaudeReturns a single checklist period (submission) by its ID, including progress details and sign-off status.
get_checklist_questions
ClaudeReturns the questions for a specific checklist, in order.
get_checklist_schedule
ClaudeReturns 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.
get_current_time
ClaudeReturns the current date, time, and Unix timestamp in milliseconds. Use it to get the current date when calculating timestamp ranges for period and process record queries.
get_option_list_details
ClaudeReturns id, display_name, and row_count for a single uploaded option list.
get_organisation_details
ClaudeReturns full details of the currently active organisation: name, timezone, active features, whether sign-off is required, available login options, AI access level, voice mode, groups, notification settings (per event: enabled, recipients, optional_recipients), and alert_types — the list of alert type ids and display names configurable for this org (e.g. majorAlert/Major Alert, minorAlert/Minor Alert). Call this before using add_answer_action with an alert action_type, since alert types are organisation-specific and not fixed. portal is set when the organisation belongs to a portal (a group of organisations managed together).
get_process
ClaudeReturns a process's full definition: settings, stages in order, parameters and reports. The stages and parameters arrays use the same shape update_process accepts, so edit them and send them back.
get_process_record
ClaudeReturns one process run, including the checklist periods completed in each stage. Use list_checklist_answers with a period id for the individual answers.
list_all_checklist_periods
ClaudeReturns all checklist periods (submissions) across every checklist for the organisation within a Unix millisecond timestamp range. Use this when the question spans multiple checklists, e.g. 'how many checks were completed this week?'. Each period includes its checklist_id and progress details. Both start_timestamp and end_timestamp are required. Timestamps are Unix milliseconds; get_current_time returns the current time in that form. Periods identify checklists by checklist_id only; list_checklists returns the names.
list_asset_types
ClaudeLists the organisation's asset types, with the asset_type_id needed by make_sticker_pack and get_asset_type.
list_assets
ClaudeLists the organisation's assets (not deleted), optionally only those of one asset_type_id from list_asset_types. An asset's ID is its sticker ID.
list_checklist_answers
ClaudeReturns all answers recorded against a specific checklist period. Each answer includes the question ID, whether it is still pending, the answer value, when/by whom it was answered, any notes added to it, and the messages of any alerts it raised. Call list_checklist_periods first to obtain a period_id.
list_checklist_categories
ClaudeLists the organisation's checklist categories and their values. A checklist's category_value_ids (from list_checklists) are value ids from here; set them with update_checklist. Categories marked managed_centrally are defined by the portal.
list_checklist_periods
ClaudeReturns completed and in-progress checklist periods (submissions) for a given checklist. Optionally filter by a Unix millisecond timestamp range. Without a range, returns the 50 most recent periods. Use this to see when a checklist was run and whether it was signed off. Timestamps are Unix milliseconds; get_current_time returns the current time in that form. Periods identify the checklist by checklist_id only; list_checklists returns the name.
list_checklists
ClaudeReturns all checklists for the organisation, including inactive ones.
list_option_lists
ClaudeLists 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.
list_organisation_users
ClaudeReturns all users who have access to the currently active organisation, including their name, email address, role, group ids and notification opt-outs.
list_organisations
ClaudeReturns the name and ID of every ChecQR organisation this user has access to, and which one is currently active. Other tools act on the active organisation; select_organisation changes it.
list_process_records
ClaudeLists process runs started within a time range, with each run's current stage, parameter values and stage history. Call get_current_time first. Omit process_ids for all processes.
list_processes
ClaudeLists the organisation's processes (multi-stage workflows made of checklists). Requires the Processes feature. Call get_process for stages, parameters and reports.
list_question_conditions
ClaudeLists 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 question's answer and fire immediately; question conditions live on the checklist, can combine an answer rule with a check-window rule, and are (re-)evaluated as answers come in during a check period.
list_sticker_packs
ClaudeLists the sticker packs assigned to this organisation, each with its stickers that are still assets (not deleted) in the organisation.
list_timezones
ClaudeLists the valid timezone names for update_organisation_settings.
make_sticker_pack
ClaudeCreates a new asset sticker pack for this organisation, the same as Build sticker pack in the dashboard, and returns download URLs for the PDF sheet and CSV. sticker_counts maps asset_type_id (from list_asset_types) to the number of stickers, 1 to 20 per type. Each sticker becomes a new asset.
remove_user_from_group
ClaudeRemoves an organisation user from a group.
request_ai_hint_image_upload
ClaudeReturns a pre-signed URL for uploading an image to use with a question's AI hint. Upload the image with an HTTP PUT to upload_url, sending the header Content-Type set to content_type. Then call update_question with ai_hint and ai_hint_image set to the returned image_file_name. The AI receives the image with the hint text when it answers the question.
request_checklist_logo_upload
ClaudeReturns a pre-signed URL for uploading a company logo for a checklist. Refused unless the checklist's user_access is externalIndividual (set with update_checklist). Upload the PNG or JPEG image with an HTTP PUT to upload_url, sending the header Content-Type set to content_type. Then call update_checklist with external_company_logo set to the returned logo_file_name. The logo is shown on the end screen external users see when they finish.
search_option_list
ClaudeSearches 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.
select_organisation
ClaudeSelects which organisation to work with. Required when the user has access to more than one.
set_my_notification_opt_outs
ClaudeSets which notification events the logged-in user opts out of in this organisation. Replaces the whole list. An event can only be opted out of when it has at least one optional_recipients group (see get_organisation_details notifications). Other requested events are not saved; they are returned in not_optional and named in the message.
set_schedule_adhoc
ClaudeRemoves all check windows and sets the checklist to ad-hoc (no fixed schedule).
update_alert_types
ClaudeReplaces the organisation's alert types and sets which one is raised when a photo that failed photo validation is saved. Call get_organisation_details first and send every alert type to keep: a type left out is deleted, which is refused while any question, asset type or the photo validation setting uses it. Leave id out for a new type. Centrally managed types are kept unchanged whatever is sent, and nothing can be changed when alert_types_locked is true. photo_validation_alert_type is an alert type id, '' for no alert, or left out to keep the current setting.
update_asset_type
ClaudeUpdates an asset type, including the alerts on its properties. Only the parts you send change; fields and properties each replace the whole list, so call get_asset_type first and send back every field, property and alert to keep, with its id. A property used by a checklist can't be removed. The exact-match lookup field is kept as it is and can only be changed in the dashboard.
update_check_window
ClaudeUpdates an existing check window. Call get_checklist_schedule first to get the window_id. Only the fields you provide are changed.
update_checklist
ClaudeRenames a checklist, changes its active status, sets who can complete it, or sets its categories. category_value_ids replaces the checklist's whole list of category values (value ids from list_checklist_categories; an empty list removes all). user_access 'externalIndividual' lets people outside the organisation complete it after scanning its QR code. The external_ settings only apply to externalIndividual checklists and are merged into the existing settings. The end screen is shown when an external user finishes; if external_different_screen_with_alerts is true and the completion raised any alert, the external_alerts_completed_ screen is shown instead. If an end screen has both button text and a URL, its button logs the user out and opens that URL. Pass an empty string to clear a text field.
update_group
ClaudeRenames and/or recolours a user group. The default Owners and Admins groups cannot be changed.
update_login_options
ClaudeChanges how people log in to the organisation's checklists. At least one of email or guest must stay on. guest_timeout is the guest session length as stored by the dashboard ('' removes it). guest_pin true generates a new 4-digit PIN, false removes the PIN.
update_notification_setting
ClaudeTurns one organisation email notification on or off and sets who receives it. recipients is ['Everyone'] or a list of group ids, and is required when enabled is true. optional_recipients lists recipient groups whose members may opt out. Any change marks the event as saved in get_organisation_details, and it stays saved after being turned back off.
update_option_list
ClaudeRenames 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).
update_organisation_settings
ClaudeChanges the organisation's name, timezone, whether checklist sign-off is required, and/or voice mode. Only the fields given are changed. AI access cannot be changed here.
update_process
ClaudeUpdates a process. Only the fields you pass change. stages and parameters each replace the whole list: call get_process first, edit the arrays, and send back every stage/parameter you want to keep, with their ids. Omitting a stage or parameter removes it.
update_process_report
ClaudeUpdates a process report's name and/or which checklists it includes. checklist_cells replaces the whole list. Only checklists that have their own custom report template can be included.
update_question
ClaudeUpdates 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. AI answering: set use_ai_to_answer true with ai_photo_question_id (an earlier Photo question on the same checklist) and AI suggests this question's answer from that photo; ai_hint tells the AI what to look for, and an empty ai_hint removes it. Not available for Photo, Selfie, Signature or PhotoAndReading questions. To send an example image with the hint, upload it with request_ai_hint_image_upload, then pass ai_hint with ai_hint_image. A question has one hint, so setting ai_hint replaces any existing hint and its image. Photo validation (Photo and Selfie questions, organisations on the new mobile app only): set photo_validation true to have each photo checked to be of the right thing, with an optional environment and object lists. It only checks the photo shows the right subject; questions about what is in the photo belong in separate AI-answered questions. A failed photo is reported to the user, and if they save it the organisation's photo validation alert type is raised (see update_alert_types). An empty string or empty list clears a photo validation setting.
update_question_condition
ClaudeUpdates a question condition. Only the fields you provide are changed, except rules — providing rules replaces the entire rule set (not a merge). Use list_question_conditions first to see the condition's current state and its condition_id.