Jump to Content
SafetyCulture
HomeGuidesSamplesAPI
SafetyCulture
API
HomeGuidesSamplesAPI

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
  • IDs
  • Rate limits
  • Acceptable use policy
  • Date/Time Format

SafetyCulture API

  • Groups
    • List groupsget
    • List groups for a userget
    • List calling user's groups and organizationsget
    • Create a grouppost
    • Add user to a grouppost
    • Remove user from a groupdelete
    • Bulk delete groupspost
    • 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
    • Create an assetpost
    • Create multiple assetspost
    • Update multiple assetsput
    • List assetspost
    • Set field values of an assetpatch
    • Get full detail information of an assetget
    • Delete an assetdelete
    • Update an assetpatch
    • Restore an archived assetdelete
    • Archive an assetpatch
    • Update asset locationpatch
    • Get asset by codeget
    • Lookup assets by a fieldpost
    • Create an asset fieldpost
    • List asset fieldspost
    • Delete an asset fielddelete
    • Update an asset fieldpatch
    • Create an asset typepost
    • List asset typespost
    • Get an asset typeget
    • Delete an asset typedelete
    • Update an asset typepatch
    • Update an asset type's asset field associationsput
    • List an asset type's asset field associationspost
  • Inspections
    • Start an inspectionpost
    • Search modified inspectionsget
    • Get an inspection (legacy)get
    • Update an inspectionput
    • Generate an inspection deep linkpost
    • Retrieve the selected media for a given inspection.get
    • Share an inspectionpost
    • Get inspection web report linkget
    • Delete inspection web report linkdelete
    • Export inspection to PDF or Wordpost
    • Get answers from an inspectionget
    • Get an inspectionget
    • Delete an inspectiondelete
    • Get details of an inspectionget
    • Restore an archived inspectiondelete
    • Archive an inspectionpost
    • Clone an inspectionpost
    • Set an inspections start or finish locationput
    • Set inspection ownerput
    • Set inspection siteput
    • Remove user access to an inspectiondelete
    • Answer an asset field questionput
    • Answer a check box questionput
    • Generate Dynamic Field (AKA Repeated Section)post
  • Credentials
    • Deletes a credential including all its versions.delete
    • Creates a credential typepost
    • Updates a credential typeput
    • Gets a credential typeget
    • Deletes a credential typedelete
    • 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)
    • 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 folderdelete
    • Retrieve users directly associated to a folderget
    • Retrieve users indirectly associated (inherited) to a folderget
    • List foldersget
    • Delete folders (bulk)delete
    • 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 foldersdelete
    • Associate users to folderspost
  • Documents
    • /documents/v1post
    • /documents/v1/{file_id}patch
    • /documents/v1/searchpost
  • 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 assigneesget
    • Data feed for schedule occurrencesget
    • Data feed for schedulesget
    • 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
  • Apps
    • Registers a new external applicationpost
    • Updates an external applicationput
    • List applicationsget
    • Create an installationpost
    • List installationsget
    • Get installationget
    • Delete an installationdelete
    • Create configurationpost
    • Updates the configurationput
    • Deletes the configurationdelete
  • Media
    • Get media download URLget
  • Users
    • 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 fielddelete
      • Update a user fieldpatch
      • Archive a fieldpost
      • Restore an archived fieldpost
      • Update field settingspost
      • Get user attributesget
      • Set user attributespost
    • Create a userpost
    • List users (by email)post
    • Get a userget
    • Update a userput
    • 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 jobdelete
      • List create-or-update users jobspost
  • Response Sets
    • Create a global response setpost
    • List global response setsget
    • Get a global response setget
    • Delete a global response setdelete
    • Update a global response setput
    • Create a global response set responsepost
    • Delete a global response set responsedelete
    • Update a global response set responseput
  • Schedules
    • List schedule itemsget
    • Create a schedule itempost
    • Delete a schedule itemdelete
    • Update a schedule itemput
  • Sensors
    • Ingest sensor readingspost
    • List sensorspost
    • Provision a sensorpost
    • Get a sensor IDget
    • Get sensor's latest readingsget
    • Get sensorget
    • De-provision a sensordelete
  • 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 linkdelete
    • 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 or update an action labelput
    • Delete a custom fielddelete
    • Rename a custom fieldput
    • Create a custom field and map it to a specific action typepost
    • Create an action typepost
    • Delete an action typedelete
    • Rename an action typeput
    • Unmap a field from a action typedelete
    • 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
  • 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
  • Templates
    • Search modified templatesget
    • Delete a template by template IDdelete
    • Restore an archived templatepost
    • Get template (by inspection)get
    • Get a templateget
    • Delete a template by template IDdelete
    • Restore an archived templatedelete
    • Archive a templatepost
  • Training
    • Collections
      • Get collectionsget
      • Get courses by collectionget
    • Courses
      • Get coursesget
      • Get lessons by course 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 Course Statisticsget
      • Get Lesson Attemptsget
      • Get Lesson Progress Eventsget
      • Get Lesson Statisticsget
      • Get Slide Statisticsget
      • Get User Lesson Progressget
      • Get Slide User Statisticsget
      • Get User Lesson Progress Eventsget
      • Get Survey Question Definitionsget
      • Get Survey Answersget
      • Get Rapid Refresh Answersget
  • Webhooks
    • Get signature secretget
    • Regenerate signature secretpost
    • List webhooksget
    • Create a webhookpost
    • Get a webhookget
    • Delete a webhookdelete
    • 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)"
  • Table of Contents
    • Requirements