For AI agents: visit https://developer.safetyculture.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
SafetyCulture Developer PortalSafetyCulture Developer Portal
HomeGuidesSamplesAPI
v1.0

SafetyCulture Developer Portal
API
v1.0HomeGuidesSamplesAPI

Getting Started

  • Introduction
  • Authentication
  • Use cases
    • Get modified inspections
    • Extract historical inspection data
    • Start and pre-fill inspections
    • Remove owner's access to a completed inspection
    • Add notes to inspection questions
    • Update inspection responses based on selected responses
    • Manage inspection access
  • IDs
  • Rate limits
  • Acceptable use policy
  • Date/Time Format

SafetyCulture API

  • Groups
    • List groups for a userget
    • List groupsget
    • List calling user's groups and organizationsget
    • Create a grouppost
    • Add user to a grouppost
    • Bulk delete groupspost
    • Remove user from a groupdel
    • List a group's or an organization's usersget
  • Heads Up
    • Gets Heads Upget
    • Get Heads Up completion countspost
    • Get a Heads Ups commentspost
    • List Heads Upspost
    • List Heads Up userspost
  • Assets
    • List assetspost
    • Create an assetpost
    • Create multiple assetspost
    • Get full detail information of an assetget
    • Get asset by codeget
    • Lookup assets by a fieldpost
    • Update an assetpatch
    • Update multiple assetsput
    • Set field values of an assetpatch
    • Update asset locationpatch
    • Archive an assetpatch
    • Restore an archived assetdel
    • Delete an assetdel
    • List asset fieldspost
    • Create an asset fieldpost
    • Update an asset fieldpatch
    • Delete an asset fielddel
    • List asset typespost
    • Create an asset typepost
    • Get an asset typeget
    • Update an asset typepatch
    • Delete an asset typedel
    • List an asset type's asset field associationspost
    • Update an asset type's asset field associationsput
    • Create a status grouppost
    • Get a status groupget
    • List status groupspost
    • Update a status grouppatch
    • Delete a status groupdel
    • Create a maintenance programpost
    • Get a maintenance programget
    • Update a maintenance programput
    • List maintenance program detailspost
    • Add assets to a maintenance programpost
    • /assets/v1/maintenance/program/{id}/assetsdel
    • Delete a maintenance programdel
    • Create a maintenance planpost
    • Update a maintenance planput
    • Delete a maintenance plandel
    • Adds maintenance last service information to assetpost
    • Add a status group to asset typespost
    • Remove a status group from asset typesdel
    • List assets maintenance detailspost
    • ListAssetsMaintenanceStatusCounts returns the maintenance status countspost
    • List asset service historypost
  • Data Feeds
    • Data feed for action assigneesget
    • Data feed for action timeline itemsget
    • Data feed for actionsget
    • Data feed for activity log eventsget
    • Data feed for assetsget
    • Data feed for group usersget
    • Data feed for groupsget
    • Data feed for inspection itemsget
    • Data feed for inspectionsget
    • Data feed for issue assigneesget
    • Data feed for issue relations itemsget
    • Data feed for issue timeline itemsget
    • Data feed for issuesget
    • Data feed for schedule assignees (legacy)get
    • Data feed for schedule occurrences (legacy)get
    • Data feed for Schedules (legacy)get
    • Data feed for site membersget
    • Data feed for sitesget
    • Data feed for template permissionsget
    • Data feed for templatesget
    • Data feed for usersget
    • Data feed for Course Progressget
    • Data feed for schedule assigneesget
    • Data feed for schedule occurrencesget
    • Data feed for schedulesget
    • Data feed for action fieldsget
    • Data feed for investigation detail fieldsget
    • Data feed for investigation fieldsget
    • Data feed for investigation relationshipsget
    • Data feed for investigationsget
    • Data feed for action fieldsget
    • Data feed for contractor companiesget
    • Data feed for contractor company documentsget
    • Data feed for contractor company membersget
    • Data feed for credential typesget
    • Data feed for credentialsget
    • Data feed for credential types
    • Data feed for credentials
    • Data feed for assets maintenance detailsget
    • Data feed for maintenance plansget
    • Data feed for maintenance programsget
  • Inspections
    • Start an inspectionpost
    • Search modified inspectionsget
    • Clone an inspectionpost
    • Get an inspection (legacy)get
    • Update an inspectionput
    • Generate an inspection deep linkpost
    • Retrieve the selected media for a given inspectionget
    • Share an inspectionpost
    • Get inspection web report linkget
    • Delete inspection web report linkdel
    • Export inspection to PDF or Wordpost
    • Get answers from an inspectionget
    • Get an inspectionget
    • Delete an inspectiondel
    • Get details of an inspectionget
    • Restore an archived inspectiondel
    • Archive an inspectionpost
    • Set an inspections start or finish locationput
    • Set inspection ownerput
    • Set inspection siteput
    • Remove user access to an inspectiondel
    • Answer an asset field questionput
    • Answer a check box questionput
    • Generate a dynamic field (repeated section)post
    • Get inspection accessget
    • Set inspection accessput
    • Complete inspectionpost
    • Create inspectionpost
    • Update inspectionput
    • Add table linepost
    • Delete table linedel
    • Update table lineput
  • Companies
    • Create a companypost
    • Get a companyget
    • Delete a companydel
    • Update a companyput
    • List company documentspost
    • List companiespost
    • List company userspost
    • List company document typespost
    • Delete a company document typedel
    • Get a company typeget
    • List company typespost
    • List company type metricspost
  • Credentials
    • Deletes a credential including all its versions.del
    • Creates a credential typepost
    • Updates a credential typeput
    • Gets a credential typeget
    • Deletes a credential typedel
    • Lists credential typespost
    • Deletes all media for a credential versionpost
    • Gets a version of a credential.get
    • Adds a version to a credential.post
    • Updates a version of a credential.put
    • Lists all versions of a credential.post
    • Lists the latest version of credentials based on applied filters.post
    • Gets the Credential settings for your organization.get
    • Updates the Credential settings for your organization.put
  • Directory (sites and template folders)
    • Create a folderpost
    • Retrieve a folderget
    • Update a folderpatch
    • Retrieve users associated to a folder, includes both directly and indirectly (inherited)get
    • Remove association for multiple users to a specific folderdel
    • Retrieve users directly associated to a folderget
    • Retrieve users indirectly associated (inherited) to a folderget
    • List foldersget
    • Delete folders (bulk)del
    • Move folder to another parent folder or as a root folderpost
    • Search folderspost
    • Get custom labelsget
    • Get folders (by parent)get
    • List folders the requesting user is associated withget
    • Remove association for a specific user to multiple foldersdel
    • Associate users to folderspost
  • Documents
    • /documents/v1post
    • /documents/v1/bulk/add_ownerspost
    • /documents/v1/{file_id}patch
    • /documents/v1/searchpost
    • /documents/v1/move/{item_id}post
    • /documents/v1/linkpost
    • /documents/v1/bulk/update_ownerspost
    • /documents/v1/bulk/remove_ownerspost
    • /documents/v1/archive/{item_id}post
    • /documents/v1/childrenpost
  • Investigations
    • Create Investigationpost
    • Delete Investigationdel
    • Get Investigation Accessget
    • Get Investigation Actionsget
    • Get Investigation Inspection Countget
    • Get Investigation Issue Countget
    • Get Investigation Media Countget
    • Get Investigation PDF Reportget
    • Get Investigationget
    • Get Investigations Countget
    • List Fieldsget
    • List Investigation Actionsget
    • List Investigation Inspectionsget
    • List Investigation Issuesget
    • List Investigation Activityget
    • List Investigation Mediaget
    • List Investigationsget
    • List Statusesget
    • Update Fieldsput
    • Update Investigationput
    • Update Investigation Accessput
    • Update Investigations (bulk)put
    • List Settings Log Eventsget
    • Update Statusesput
    • List Categoriesget
    • Create Categorypost
    • Delete Categorydel
    • Update Categoryput
    • Clone Categorypost
    • List Category Detail Fieldsget
    • Set Category Detail Fieldsput
    • Create Detail Fieldpost
    • Delete Detail Fielddel
    • Rename Detail Fieldput
    • Set Detail Field Optionsput
    • List Detail Field Libraryget
    • List Investigation Coursesget
    • Get Investigation Course Countget
  • OSHA
    • List Casesget
    • Create Casepost
    • Update Caseput
    • Get Caseget
    • Delete Casedel
    • List Establishmentsget
    • Create Establishmentpost
    • Update Establishmentput
    • Get Establishmentget
    • Delete Establishmentdel
    • Get Establishment Employeesget
    • Update Establishment Employeespost
    • Get Establishment Hoursget
    • Update Establishment Hourspost
  • Apps
    • Registers a new external applicationpost
    • List applicationsget
    • Updates an external applicationput
    • Create an installationpost
    • Create configurationpost
    • List all installationsget
    • Get installationget
    • Delete an installationdel
    • Deletes the configurationdel
    • Updates the configurationput
  • Lone Worker
    • Get jobsget
  • Media
    • Get media download URLget
  • Users
    • Create a user (legacy)post
    • Bulk user operations
      • Bulk user operations errors
      • Create or update users synchronouslypost
      • Initialize a create-or-update users jobpost
      • Start a create-or-update users jobpost
      • Get a create-or-update users jobget
      • Cancel a create-or-update users jobdel
      • List create-or-update users jobspost
    • Permission sets
      • Assign user to a permission setpost
      • Get a permission setget
      • List permission setspost
    • User fields
      • Create a user fieldpost
      • List user fieldspost
      • Delete a user fielddel
      • Update a user fieldpatch
      • Archive a fieldpost
      • Restore an archived fieldpost
      • Update field settingspost
      • Get user attributesget
      • Set user attributespost
    • List users by email (legacy)post
    • Get a user (legacy)get
    • Update a user (legacy)put
    • List userspost
  • Response Sets
    • Create a global response setpost
    • List global response setsget
    • Get a global response setget
    • Delete a global response setdel
    • Update a global response setput
    • Create a global response set responsepost
    • Delete a global response set responsedel
    • Update a global response set responseput
  • Schedules (legacy)
    • Create a schedule itempost
    • List schedule itemsget
    • Update a schedule itemput
    • Delete a schedule itemdel
  • Schedules
    • Create a new schedulepost
    • Get a scheduleget
    • List schedule targetsget
    • List schedule accessget
    • Pause a schedulepatch
    • Resume a schedulepatch
    • End a schedulepatch
    • Update schedule detailspatch
    • Update schedule recurrencepatch
    • Update schedule assigneespatch
    • Update schedule targetpatch
    • Delete a scheduledel
  • Sensors
    • Ingest sensor readingspost
    • List sensorspost
    • Provision a sensorpost
    • Get a sensor IDget
    • Get sensor's latest readingsget
    • Get sensorget
    • De-provision a sensordel
  • Actions
    • Create an actionpost
    • Delete actions (Bulk)post
    • List actionspost
    • Updates the labels associated with an actionput
    • Get an Actionget
    • Update the asset of an actionput
    • Update the assignees of an actionput
    • Update the description of an actionput
    • Update the due date of an actionput
    • Update the priority of an actionput
    • Get an action linkget
    • Delete an action linkdel
    • Create an action linkpost
    • Update the site of an actionput
    • Update the status of an actionput
    • Update the title of an actionput
    • Get all action labelsget
    • Delete action labelspost
    • Create an action with recurring schedulepost
    • Create or update an action labelput
    • Delete a custom fielddel
    • Rename a custom fieldput
    • Create a custom field and map it to a specific action typepost
    • Create an action typepost
    • Delete an action typedel
    • Rename an action typeput
    • Unmap a field from a action typedel
    • Map a field to a action typeput
    • Get all custom fields mapped to a specific action typeget
    • Get the custom fields not mapped to a specific action typeget
    • Update a custom field for an Actionput
    • Get a single action type by idget
    • List all action types for the orgget
  • Issues
    • List Categoriesget
    • Get Issueget
    • Create Issue (legacy)post
    • Delete Issuespost
    • List Issuespost
    • Get count of Issuespost
    • Create Issuepost
    • Get Issue (legacy)get
    • Get Issue questions and answersget
    • Update Categoryput
    • Add Issue assigneepost
    • Remove Issue assigneepost
    • Update Issue descriptionput
    • Update Issue due dateput
    • Update Issue occurred atput
    • Export Issue to PDFget
    • Update Issue priorityput
    • Update Issue siteput
    • Updates Issue statusput
    • Update Issue titleput
    • Get Issue web report linkpost
    • List timeline eventspost
    • Add comment to timelinepost
    • Update Issue assetput
  • Template Definition
    • Get template definitionget
  • Templates
    • Search modified templatesget
    • Get template (by inspection)get
    • Get a templateget
    • Delete a template by template IDdel
    • Restore an archived templatedel
    • Archive a templatepost
  • Training
    • Collections
      • Get collectionsget
      • Get courses by collectionget
    • Courses
      • Get coursesget
      • Get lessons by course IDget
      • Update course assignmentsput
    • Lessons
      • Get lesson by IDget
    • Paths
      • Get pathsget
      • Get path by IDget
    • Individual Leaderboards
      • Get individual leaderboardsget
      • Get individual leaderboard rankingsget
    • Rapid Refresh
      • Get rapid refreshget
      • Get rapid refresh by IDget
    • Analytics
      • Get Slide Statistics
      • Get Course Statisticsget
      • Get Lesson Attemptsget
      • Get Lesson Progress Eventsget
      • Get Lesson Statisticsget
      • Get Slide Statisticsget
      • Get Slide User Statisticsget
      • Get User Lesson Progressget
      • Get User Lesson Progress Eventsget
      • Get Survey Question Definitionsget
      • Get Survey Answersget
      • Get Rapid Refresh Answersget
    • Reset a course's progress
      • Reset course progresspost
  • Webhooks
    • Get signature secretget
    • Regenerate signature secretpost
    • List webhooksget
    • Create a webhookpost
    • Get a webhookget
    • Delete a webhookdel
    • Update a webhookput

Rapid Refresh

Rapid Refresh Quizzes are an efficient way to re-engage team members who may have forgotten their learnings from training courses.

Requirements

  • "Training: Manage content (all)"

Updated 8 months ago


Get individual leaderboard rankings
Get rapid refresh
Did this page help you?

Updated 8 months ago


Get individual leaderboard rankings
Get rapid refresh
Did this page help you?
    • Requirements