Jump to Content
Home
Guides
Samples
API
v1.0-beta
v1.0-pre
v1.0
API
Moon (Dark Mode)
Sun (Light Mode)
v1.0
Home
Guides
Samples
API
Companies
Search
JUMP TO
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 groups
get
List a user's groups
get
List your groups and organizations
get
Create a group
post
Add a user to a group
post
Remove a user from a group
delete
Bulk delete groups
post
List a group's or organization's users
get
Heads Up
Gets Heads Up
get
Get Heads Up completion counts
post
Get a Heads Ups comments
post
List Heads Ups
post
List Heads Up users
post
Assets
Create an asset
post
Create multiple assets
post
Update multiple assets
put
List assets
post
Set field values of an asset
patch
Get full detail information of an asset
get
Delete an asset
delete
Update an asset
patch
Restore an archived asset
delete
Archive an asset
patch
Update asset location
patch
Get asset by code
get
Lookup assets by a field
post
Create an asset field
post
List asset fields
post
Delete an asset field
delete
Update an asset field
patch
Create an asset type
post
List asset types
post
Get an asset type
get
Delete an asset type
delete
Update an asset type
patch
Update an asset type's asset field associations
put
List an asset type's asset field associations
post
Inspections
Start an inspection
post
Search modified inspections
get
Get an inspection (legacy)
get
Update an inspection
put
Generate an inspection deep link
post
Retrieve the selected media for a given inspection.
get
Share an inspection
post
Get inspection web report link
get
Delete inspection web report link
delete
Export inspection to PDF or Word
post
Get answers from an inspection
get
Get an inspection
get
Delete an inspection
delete
Get details of an inspection
get
Restore an archived inspection
delete
Archive an inspection
post
Clone an inspection
post
Set an inspections start or finish location
put
Set inspection owner
put
Set inspection site
put
Remove user access to an inspection
delete
Answer an asset field question
put
Answer a check box question
put
Generate Dynamic Field (AKA Repeated Section)
post
Contractors
Lists companies based on applied filters.
post
Gets a contractor company.
get
Deletes a contractor company.
delete
Creates a new company.
post
Updates an existing contractor company.
put
ListCompanyUserMetadata returns a list of users in a company, along with any additional metadata.
post
Companies
Credentials
Delete a credential
delete
Create a credential type
post
Update a credential type
put
Get a credential type
get
Delete a credential type
delete
List credential types
post
Deletes all media for a credential version
post
Get a credential version
get
Create a credential version
post
Update a credential version
put
List credential versions
post
List credentials
post
Get credential settings
get
Update credential settings
put
Directory (sites and template folders)
Create a folder
post
Retrieve a folder
get
Update a folder
patch
Retrieve users associated to a folder, includes both directly and indirectly (inherited)
get
Remove association for multiple users to a specific folder
delete
Retrieve users directly associated to a folder
get
Retrieve users indirectly associated (inherited) to a folder
get
List folders
get
Delete folders (bulk)
delete
Move folder to another parent folder or as a root folder
post
Search folders
post
Get custom labels
get
Get folders (by parent)
get
List folders the requesting user is associated with
get
Remove association for a specific user to multiple folders
delete
Associate users to folders
post
Documents
Create a file
post
Update a file
patch
Search files and folders
post
Data Feeds
Data feed for action assignees
get
Data feed for action timeline items
get
Data feed for actions
get
Data feed for activity log events
get
Data feed for assets
get
Data feed for group users
get
Data feed for groups
get
Data feed for inspection items
get
Data feed for inspections
get
Data feed for issue assignees
get
Data feed for issue relations items
get
Data feed for issue timeline items
get
Data feed for issues
get
Data feed for schedule assignees
get
Data feed for schedule occurrences
get
Data feed for schedules
get
Data feed for site members
get
Data feed for sites
get
Data feed for template permissions
get
Data feed for templates
get
Data feed for users
get
Data feed for Course Progress
get
Apps
Register application
post
Update application
put
List applications
get
Create installation
post
List installations
get
Get installation
get
Delete installation
delete
Create configuration
post
Update configuration
put
Delete configuration
delete
Media
Get media download URL
get
Users
Bulk user operations
Bulk user operations errors
Create or update users synchronously
post
Initialize create-or-update users job
post
Start create-or-update users job
post
Get create-or-update users job
get
Cancel create-or-update users job
delete
List create-or-update users jobs
post
Permission sets
Assign user to a permission set
post
Get a permission set
get
List permission sets
post
User fields
Create a user field
post
List user fields
post
Delete a user field
delete
Update a user field
patch
Archive a field
post
Restore an archived field
post
Update field settings
post
Get user attributes
get
Set user attributes
post
Create a user
post
List users (by email)
post
Get a user
get
Update a user
put
Response Sets
Create a global response set
post
List global response sets
get
Get a global response set
get
Delete a global response set
delete
Update a global response set
put
Create a global response set response
post
Delete a global response set response
delete
Update a global response set response
put
Schedules
List schedule items
get
Create a schedule item
post
Delete a schedule item
delete
Update a schedule item
put
Sensors
Ingest sensor readings
post
List sensors
post
Provision sensors
post
Get a sensor ID
get
Get sensor's latest readings
get
Get sensor
get
De-provision a sensor
delete
Actions
Create an action
post
Delete actions (Bulk)
post
Get actions
post
Updates the labels associated with an action
put
Get an Action
get
Update the asset of an action
put
Update the assignees of an action
put
Update the description of an action
put
Update the due date of an action
put
Update the priority of an action
put
Get an action link
get
Delete an action link
delete
Create an action link
post
Update the site of an action
put
Update the status of an action
put
Update the title of an action
put
Get all action labels
get
Delete action labels
post
Create or update an action label
put
Delete a custom field
delete
Rename a custom field
put
Create a custom field and map it to a specific action type
post
Create an action type
post
Delete an action type
delete
Rename an action type
put
Unmap a field from a action type
delete
Map a field to a action type
put
Get all custom fields mapped to a specific action type
get
Get the custom fields not mapped to a specific action type
get
Update a custom field for an Action
put
Issues
List Categories
get
Get Issue
get
Create Issue (legacy)
post
Delete Issues
post
List Issues
post
Get count of Issues
post
Create Issue
post
Get Issue (legacy)
get
Get Issue questions and answers
get
Update Category
put
Add Issue assignee
post
Remove Issue assignee
post
Update Issue description
put
Update Issue due date
put
Update Issue occurred at
put
Export Issue to PDF
get
Update Issue priority
put
Update Issue site
put
Updates Issue status
put
Update Issue title
put
Get Issue web report link
post
List timeline events
post
Add comment to timeline
post
Templates
Search modified templates
get
Delete a template by template ID
delete
Restore an archived template
post
Get template (by inspection)
get
Get a template
get
Delete a template by template ID
delete
Restore an archived template
delete
Archive a template
post
Training
Collections
Get collections
get
Get courses by collection
get
Courses
Get courses
get
Get lessons by course ID
get
Paths
Get paths
get
Get path by ID
get
Individual Leaderboards
Get individual leaderboards
get
Get individual leaderboard rankings
get
Rapid Refresh
Get rapid refresh
get
Get rapid refresh by ID
get
Analytics
Get Course Statistics
get
Get Lesson Attempts
get
Get Lesson Progress Events
get
Get Lesson Statistics
get
Get Slide Statistics
get
Get User Lesson Progress
get
Get Slide User Statistics
get
Get User Lesson Progress Events
get
Get Survey Question Definitions
get
Get Survey Answers
get
Get Rapid Refresh Answers
get
Webhooks
Get signature secret
get
Regenerate signature secret
post
List webhooks
get
Create a webhook
post
Get a webhook
get
Delete a webhook
delete
Update a webhook
put
Companies
