Jump to Content
Home
Guides
Samples
API
v1.0-pre
v1.0
API
v1.0
Home
Guides
Samples
API
Response Sets
All
Pages
Start typing to search…
JUMP TO
Getting Started
Authentication
Introduction
IDs
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
Acceptable use policy
Rate limits
Date/Time Format
SafetyCulture API
Groups
List a user's groups
get
List groups
get
List your groups and organizations
get
Create a group
post
Add a user to a group
post
Bulk delete groups
post
Remove a user from a group
del
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
del
Update an asset
patch
Restore an archived asset
del
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
del
Update an asset field
patch
Create an asset type
post
List asset types
post
Get an asset type
get
Delete an asset type
del
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
del
Export inspection to PDF or Word
post
Get answers from an inspection
get
Get an inspection
get
Delete an inspection
del
Get details of an inspection
get
Restore an archived inspection
del
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
del
Answer an asset field question
put
Answer a check box question
put
Generate a dynamic field (repeated section)
post
Get inspection access
get
Set inspection access
put
Companies
List companies
post
Create a company
post
Get a company
get
Delete a company
del
Update a company
put
List company users
post
List company type metrics
post
Delete company document type
del
List company documents
post
List company document types
post
Get a company type
get
List company types
post
Credentials
Delete a credential
del
Create a credential type
post
Update a credential type
put
Get a credential type
get
Delete a credential type
del
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
del
Retrieve users directly associated to a folder
get
Retrieve users indirectly associated (inherited) to a folder
get
List folders
get
Delete folders (bulk)
del
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
del
Associate users to folders
post
Documents
Create a file
post
Bulk add file owners
post
Update a file
patch
Search files and folders
post
Move files and folders
post
Link files
post
Archive files and folders
post
Bulk update file owners
post
Bulk remove file owners
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 (v1)
get
Data feed for schedule occurrences (v1)
get
Data feed for schedules (v1)
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
Data feed for schedule assignees (v2)
get
Data feed for schedule occurrences (v2)
get
Data feed for schedules (v2)
get
Data feed for action fields
get
Data feed for investigation detail fields
get
Data feed for investigation fields
get
Data feed for investigation relationships
get
Data feed for investigations
get
Data feed for action fields
get
Investigations
Create Investigation
post
Delete Investigation
del
Get Investigation Access
get
Get Investigation Actions
get
Get Investigation Inspection Count
get
Get Investigation Issue Count
get
Get Investigation Media Count
get
Get Investigation PDF Report
get
Get Investigation
get
Get Investigations Count
get
List Fields
get
List Investigation Actions
get
List Investigation Inspections
get
List Investigation Issues
get
List Investigation Activity
get
List Investigation Media
get
List Investigations
get
List Statuses
get
Update Fields
put
Update Investigation
put
Update Investigation Access
put
Update Investigations (bulk)
put
List Settings Log Events
get
Update Statuses
put
List Categories
get
Create Category
post
Delete Category
del
Update Category
put
Clone Category
post
List Category Detail Fields
get
Set Category Detail Fields
put
Create Detail Field
post
Delete Detail Field
del
Rename Detail Field
put
Set Detail Field Options
put
List Detail Field Library
get
OSHA
List Cases
get
Create Case
post
Update Case
put
Get Case
get
Delete Case
del
List Establishments
get
Create Establishment
post
Update Establishment
put
Get Establishment
get
Delete Establishment
del
Get Establishment Employees
get
Update Establishment Employees
post
Get Establishment Hours
get
Update Establishment Hours
post
Apps
Register application
post
List applications
get
Update application
put
Create installation
post
Create configuration
post
List installations
get
Get installation
get
Delete installation
del
Delete configuration
del
Update configuration
put
Media
Get media download URL
get
Get media download URL
Users
Create a user
post
Bulk user operations
Bulk user operations errors
Create or update users synchronously
post
Initialize create-or-update users job
post
Get create-or-update users job
get
Start create-or-update users job
post
Cancel create-or-update users job
del
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
del
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
List users (by email)
post
Get a user
get
Update a user
put
Get a user
Response Sets
Create a global response set
post
List global response sets
get
Get a global response set
get
Delete a global response set
del
Update a global response set
put
Create a global response set response
post
Delete a global response set response
del
Update a global response set response
put
Schedules (v1)
List schedule items
get
Create a schedule item
post
Delete a schedule item
del
Update a schedule item
put
Schedules (v2)
Create a schedule item
post
Delete a schedule item
post
List schedule items
get
Update a schedule item
post
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
del
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
del
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 an action with recurring schedule
post
Create or update an action label
put
Delete a custom field
del
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
del
Rename an action type
put
Unmap a field from a action type
del
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
Get template (by inspection)
get
Get a template
get
Delete a template by template ID
del
Restore an archived template
del
Archive a template
post
Training
Collections
Get collections
get
Get courses by collection
get
Courses
Get courses
get
Get lessons by course ID
get
Update course assignments
put
Lessons
Get lesson by ID
get
Paths
Get path by ID
get
Get paths
get
Individual Leaderboards
Get individual leaderboard rankings
get
Get individual leaderboards
get
Analytics
Get Slide Statistics
Get Course Statistics
get
Get Lesson Attempts
get
Get Lesson Progress Events
get
Get Lesson Statistics
get
Get Slide Statistics
get
Get Slide User Statistics
get
Get User Lesson Progress
get
Get User Lesson Progress Events
get
Get Survey Question Definitions
get
Get Survey Answers
get
Get Rapid Refresh Answers
get
Rapid Refresh
Get rapid refresh
get
Get rapid refresh by ID
get
Reset a course's progress
Reset course progress
post
Webhooks
Get signature secret
get
Regenerate signature secret
post
List webhooks
get
Create a webhook
post
Get a webhook
get
Delete a webhook
del
Update a webhook
put
Lone Worker
Get jobs
get
Structures
Inspection Access
Set inspection access
post
Powered by
Response Sets
Ask AI
