iAuditor

iAuditor is the world's most popular inspection checklist app. SafetyCulture is iAuditor's cloud based backup and management system. Manage all your inspection teams and analyse data collected from the field. iAuditor and SafetyCulture give you real-time visibility across your entire operation.

Status: Preview

Tier: Premium

Version: 1.0.0

Actions:

Name	Summary
SearchAudits ([Optional]string order, [Optional]string modified_after, [Optional]string modified_before, [Optional]string template, [Optional]string archived, [Optional]string completed, [Optional]string owner, [Optional]integer limit)	Search modified inspections
GetAuditById (string auditId)	Get a specific inspection
ArchiveRestoreAudit (string auditId, [Optional]ArchiveRestoreAuditParameterBody body)	Set the archived state of an inspection
CreateAuditLink (string auditId)	Generate a link to an inspection
InitiateAuditExport (string auditId, string format, [Optional]string timezone, [Optional]string export_profile)	Export an audit report (legacy)
PollExportStatus (string auditId, string exportId)	Check the status of the export request submitted earlier (legacy)
GetAuditExport (string auditId, string exportId, string filename)	Download an audit report (legacy)
GetWebReportLink (string auditId)	Retrieve an inspection web report link
DeleteWebReportLink (string auditId)	Disable an inspection web report link
SearchExportProfiles ()	Get a list of available export profiles
SearchTemplates ([Optional]string order, [Optional]string modified_after, [Optional]string modified_before, [Optional]string archived, [Optional]string owner, [Optional]integer limit)	Search modified templates
SearchActions ([Optional]SearchActionsParameterSearchActionsBody SearchActionsBody)	Search actions
CreateAction (CreateActionParameterCreateActionBody CreateActionBody)	Create an action
DeleteAction (string actionId)	Delete an action
UpdateAction (string actionId, UpdateActionParameterUpdateActionBody UpdateActionBody)	Update an action
GetMedia (string auditId, string mediaId)	Get an inspection media
SearchPreferences ()	Search global preferences
InitiateInspectionExport (string auditId, InitiateInspectionExportParameterFormat format)	Export an inspection report
PollInspectionExportStatus (string auditId, string exportId)	Check inspection export status

Triggers:

Name

Summary

Objects:

Name	Summary
action
ActionsSearchResponse
ArchiveRestoreAuditParameterBody
AuditSearchResponse
CreateActionParameterCreateActionBody
created_at	Created
DeleteActionResponse
due_at	Due
ExportStatusResponse
GetAuditByIdResponse
GetAuditLinkResponse
InitExportResponse
InitiateInspectionExportParameterFormat
InitInspectionExportResponse
InspectionExportStatusResponse
modified_at	Modified
PreferenceSearchResponse
SearchActionsParameterSearchActionsBody
SearchExportProfilesResponse
TemplateSearchResponse
UpdateActionParameterUpdateActionBody

Actions:

SearchAudits

Summary: Search modified inspections

Description: Retrieve the list of inspections filtered by dates, template, completion status and more.

Syntax:

iAuditor.SearchAudits ([Optional]string order, [Optional]string modified_after, [Optional]string modified_before, [Optional]string template, [Optional]string archived, [Optional]string completed, [Optional]string owner, [Optional]integer limit)

Parameters:

Name	Type	Summary	Required	Related Action
order	string (Sort Order)Values: [desc, asc]	The date and time order in which the results will be given.	False
modified_after	string(date-time) (Modified After)	Filter to include results last modified after this date and time.	False
modified_before	string(date-time) (Modified Before)	Filter to include results last modified before this date and time.	False
template	string (Filter by Template)	Filter to include results from a specific template.	False	SearchTemplates
archived	string (Archived)Values: [true, false, both]	Filter to include only archived (true), non-archived (false), or both.	False
completed	string (Completed)Values: [true, false, both]	Filter results to include only complete, incomplete, or both.	False
owner	string (Ownership)Values: [me, other, all]	Retrieve results owned by me, shared with me by other users, or all that I have access to.	False
limit	integer (Limit (Max 1000))	Maximum number of results to return. Shorten your recurrence and get past time intervals to retrieve more results	False

Returns:

Type:AuditSearchResponse

GetAuditById

Summary: Get a specific inspection

Description: Retrieve the full data of an inspection.

Syntax:

iAuditor.GetAuditById (string auditId)

Parameters:

Name

Type

Summary

Required

Related Action

auditId

string

(Audit ID)

The unique identifier of a specific inspection.

True

Returns:

Type:GetAuditByIdResponse

ArchiveRestoreAudit

Summary: Set the archived state of an inspection

Description: Choose 'Yes' to archive the inspection and 'No' to restore the archived inspection.

Syntax:

iAuditor.ArchiveRestoreAudit (string auditId, [Optional]ArchiveRestoreAuditParameterBody body)

Parameters:

Name

Type

Summary

Required

Related Action

auditId

string

(Audit ID)

The unique identifier of a specific inspection.

True

body

ArchiveRestoreAuditParameterBody

False

Returns:

Type:GetAuditByIdResponse

CreateAuditLink

Summary: Generate a link to an inspection

Description: Generate a link to a specific inspection that opens in iAuditor/SafetyCulture.

Syntax:

iAuditor.CreateAuditLink (string auditId)

Parameters:

Name

Type

Summary

Required

Related Action

auditId

string

(Audit ID)

The unique identifier of a specific inspection.

True

Returns:

Type:GetAuditLinkResponse

InitiateAuditExport

Summary: Export an audit report (legacy)

Description: Submit an export request for an audit into the format passed as a query parameter.

Syntax:

iAuditor.InitiateAuditExport (string auditId, string format, [Optional]string timezone, [Optional]string export_profile)

Parameters:

Name	Type	Summary	Required	Related Action
auditId	string (Audit ID)	The unique identifier of a specific inspection.	True
format	string (Format)Values: [pdf, docx]	The format to generate an export in.	True
timezone	string (Timezone)Values: [Pacific/Auckland, Australia/Brisbane, Asia/Tokyo, Asia/Shanghai, Asia/Karachi, Europe/Moscow, Europe/Brussels, Europe/London, America/St_Johns, America/Argentina/Buenos_Aires, America/New_York, America/Mexico_City, America/Guatemala, Etc/UTC]	The timezone to use when generating an export.	False
export_profile	string (Export Profile)	The unique identifier of the export profile to generate an export with.	False	SearchExportProfiles

Returns:

Type:InitExportResponse

PollExportStatus

Summary: Check the status of the export request submitted earlier (legacy)

Description: Check whether the download report submitted earlier is ready for download.

Syntax:

iAuditor.PollExportStatus (string auditId, string exportId)

Parameters:

Name

Type

Summary

Required

Related Action

auditId

string

(Audit ID)

The unique identifier of a specific inspection.

True

exportId

string

(Export Task ID)

The unique identifierof an export task.

True

Returns:

Type:ExportStatusResponse

GetAuditExport

Summary: Download an audit report (legacy)

Description: Download the audit report submitted earlier.

Syntax:

iAuditor.GetAuditExport (string auditId, string exportId, string filename)

Parameters:

Name	Type	Summary	Required	Related Action
auditId	string (Audit ID)	The unique identifier of a specific inspection.	True
exportId	string (Export Task ID)	The unique identifierof an export task.	True
filename	string (Inspection Report Filename)	The filename generated by an export request.	True

Returns:

Type:string(binary)

Summary: Audit Report

Description: Audit Report as either PDF or Docx file.

GetWebReportLink

Summary: Retrieve an inspection web report link

Description: If a link has previously been generated for this inspection, it is returned. Otherwise a new link is generated.

Syntax:

iAuditor.GetWebReportLink (string auditId)

Parameters:

Name

Type

Summary

Required

Related Action

auditId

string

(Audit ID)

The unique identifier of a specific inspection.

True

Returns:

Type:GetAuditLinkResponse

DeleteWebReportLink

Summary: Disable an inspection web report link

Description: Disable the web report link to an inspection.

Syntax:

iAuditor.DeleteWebReportLink (string auditId)

Parameters:

Name

Type

Summary

Required

Related Action

auditId

string

(Audit ID)

The unique identifier of a specific inspection.

True

Returns:

SearchExportProfiles

Summary: Get a list of available export profiles

Description: Profile ids can be used in export requests to ally the specified export profile.

Syntax:

iAuditor.SearchExportProfiles ()

Returns:

Type:SearchExportProfilesResponse

SearchTemplates

Summary: Search modified templates

Description: Retrieve the list of templates between certain dates and by other constraints.

Syntax:

iAuditor.SearchTemplates ([Optional]string order, [Optional]string modified_after, [Optional]string modified_before, [Optional]string archived, [Optional]string owner, [Optional]integer limit)

Parameters:

Name	Type	Summary	Required	Related Action
order	string (Sort Order)Values: [desc, asc]	The date and time order in which the results will be given.	False
modified_after	string(date-time) (Modified After)	Filter to include results last modified after this date and time.	False
modified_before	string(date-time) (Modified Before)	Filter to include results last modified before this date and time.	False
archived	string (Archived)Values: [true, false, both]	Filter to include only archived (true), non-archived (false), or both.	False
owner	string (Ownership)Values: [me, other, all]	Retrieve results owned by me, shared with me by other users, or all that I have access to.	False
limit	integer (Limit (Max 1000))	Maximum number of results to return. Shorten your recurrence and get past time intervals to retrieve more results	False

Returns:

Type:TemplateSearchResponse

SearchActions

Summary: Search actions

Description: Find actions related based upon their status, priority, assignees, item, inspection and more.

Syntax:

iAuditor.SearchActions ([Optional]SearchActionsParameterSearchActionsBody SearchActionsBody)

Parameters:

Name

Type

Summary

Required

Related Action

SearchActionsBody

SearchActionsParameterSearchActionsBody

False

Returns:

Type:ActionsSearchResponse

CreateAction

Summary: Create an action

Description: Create a new action

Syntax:

iAuditor.CreateAction (CreateActionParameterCreateActionBody CreateActionBody)

Parameters:

Name

Type

Summary

Required

Related Action

CreateActionBody

CreateActionParameterCreateActionBody

True

Returns:

Type:action

DeleteAction

Summary: Delete an action

Description: Delete an existing action

Syntax:

iAuditor.DeleteAction (string actionId)

Parameters:

Name

Type

Summary

Required

Related Action

actionId

string

(Action ID)

The unique identifier of a specific action.

True

Returns:

Type:DeleteActionResponse

UpdateAction

Summary: Update an action

Description: Update an existing action

Syntax:

iAuditor.UpdateAction (string actionId, UpdateActionParameterUpdateActionBody UpdateActionBody)

Parameters:

Name

Type

Summary

Required

Related Action

actionId

string

(Action ID)

The unique identifier of a specific action.

True

UpdateActionBody

UpdateActionParameterUpdateActionBody

True

Returns:

Type:action

GetMedia

Summary: Get an inspection media

Description: Get a media file from an inspection

Syntax:

iAuditor.GetMedia (string auditId, string mediaId)

Parameters:

Name

Type

Summary

Required

Related Action

auditId

string

(Audit ID)

The unique identifier of a specific inspection.

True

mediaId

string

(media ID)

The unique identifier of a specific media file.

True

Returns:

Type:string(binary)

Summary: Media File

Description: The media file from an inspection

SearchPreferences

Summary: Search global preferences

Description: Retrieve the list of Report Preferences available to all templates.

Syntax:

iAuditor.SearchPreferences ()

Returns:

Type:PreferenceSearchResponse

InitiateInspectionExport

Summary: Export an inspection report

Description: Submit an export request for an inspection report in the selected format.

Syntax:

iAuditor.InitiateInspectionExport (string auditId, InitiateInspectionExportParameterFormat format)

Parameters:

Name

Type

Summary

Required

Related Action

auditId

string

(Audit ID)

The unique identifier of a specific inspection.

True

format

InitiateInspectionExportParameterFormat

True

Returns:

Type:InitInspectionExportResponse

PollInspectionExportStatus

Summary: Check inspection export status

Description: Check the inspection export status.

Syntax:

iAuditor.PollInspectionExportStatus (string auditId, string exportId)

Parameters:

Name

Type

Summary

Required

Related Action

auditId

string

(Audit ID)

The unique identifier of a specific inspection.

True

exportId

string

(Export Task ID)

The unique identifierof an export task.

True

Returns:

Type:InspectionExportStatusResponse

action

Summary:

Description:

Properties:

Name	Type	Summary
action_id	string Action ID	The unique identifier of the action.
audit	Audit Inspection	The inspection that the action is associated with.
item	Item Item	The inspection question/item that the action is associated with.
description	string Description	The description of the action.
title	string Title	The title of the action.
site	string Site	The selected site of the action.
priority	integer(int32) Priority	The priority of the action: 0=None, 10=Low, 20=Medium, 30=High.
status	integer(int32) Status	The status of the action: 0=To Do, 10=In Progress, 50=Done, 60=Can't Do.
assignees	array of (AssigneesItem) Assignees	The assignees of the action.
created_by	Created_by Created By	The user who created the action.
created_at	string(date-time) Creation Date	The date and time the action was created.
modified_at	string(date-time) Modification Date	The date and time the action was last modified.
due_at	string(date-time) Due Date	The date and time the action was due.
completed_at	string(date-time) Completion Date	The date and time the action was completed.

Audit

Summary: Inspection

Description: The inspection that the action is associated with.

Properties:

Name

Type

Summary

audit_id

string

Audit ID

The unique identifier of the inspection.

name

string

Inspection Title

The name/title of the inspection.

Item

Summary: Item

Description: The inspection question/item that the action is associated with.

Properties:

Name

Type

Summary

item_id

string

Item ID

The question/item's unique identifier.

label

string

Item Label

The question/item's label.

AssigneesItem

Summary:

Description:

Properties:

Name	Type	Summary
id	string Assignee ID	The assignee's user ID or email (external).
name	string Assignee Name	The action assignee's name or email (external).
type	string Type	The type of assignee. Either 'user' or 'email (external)'.

Created_by

Summary: Created By

Description: The user who created the action.

Properties:

Name

Type

Summary

user_id

string

Creator ID

The unique identifier of the user who created the action.

name

string

Creator Name

The name of the user who created the action.

ActionsSearchResponse

Summary:

Description:

Properties:

Name	Type	Summary
count	number Count	The number of actions returned.
total	number Total	The total number of actions found in the search parameters.
offset	number Offset	The offset/page of the current set of results.
actions	array of (action) Actions	Actions

ArchiveRestoreAuditParameterBody

Summary:

Description:

Properties:

Name

Type

Summary

archived

boolean

Archived

Yes/No

AuditSearchResponse

Summary:

Description:

Properties:

Name	Type	Summary
count	number Count	The number of actions returned.
total	number Total	The total number of actions found in the search parameters.
audits	array of (AuditsItem) Inspection

AuditsItem

Summary:

Description:

Properties:

Name	Type	Summary
audit_id	string Audit ID	The unique identifier of the inspection.
modified_at	string(date-time) Date Modified	The date and time the inspection was last modified, in the format of: yyyy-MM-ddTHH:mm:ss.fffZ (UTC time).
template_id	string Template ID	The unique identifier of the template.

CreateActionParameterCreateActionBody

Summary:

Description:

Properties:

Name	Type	Summary
audit_id	string Audit ID	The unique identifer of the inspection.
item_id	string Item ID	The unique identifier of the question/item.
title	string Title	The text to use for the action title.
description	string Description	The text to use for the action description.
priority	string Priority	The priority to assign for the action: 0=None, 10=Low, 20=Medium, 30=High. Values: [0, 10, 20, 30]
status	string Status	The status to set for the action: 0=To Do, 10=In Progress, 50=Done, 60=Can't Do. Values: [0, 10, 50, 60]
due_at	string(date-time) Due At	The due date and time to set for the action.
assignees	array of (AssigneesItem) Assignees	Users assigned the action.

AssigneesItem

Summary:

Description:

Properties:

Name

Type

Summary

string

Assignee ID

The assignee's user ID or email (external).

type

string

Type

The type of assignee. Either 'user' or 'email (external)'. Values: [user, email]

created_at

Summary: Created

Description: Creation date filter.

Properties:

Name

Type

Summary

from

string(date-time)

After Date

Search for results created after this date and time.

string(date-time)

Before Date

Search for results created before this date and time.

DeleteActionResponse

Summary:

Description:

Properties:

Name

Type

Summary

boolean

due_at

Summary: Due

Description: Due date filter.

Properties:

Name

Type

Summary

from

string(date-time)

After Date

Search for results due after this date and time.

string(date-time)

Before Date

Search for results due before this date and time.

ExportStatusResponse

Summary:

Description:

Properties:

Name	Type	Summary
status	string Export Status	The current status of the export request.
href	string Export URL	The web URL to the exported inspection report file.
filename	string Filename	The filename of the exported inspection report.

GetAuditByIdResponse

Summary:

Description:

Properties:

Name	Type	Summary
template_id	string Template ID	The unique identifier of the template.
audit_id	string Audit ID	The unique identifier of the inspection.
audit_data	Audit_data
template_data	Template_data

Audit_data

Summary:

Description:

Properties:

Name	Type	Summary
score	number Score	The score achieved in the inspection.
total_score	number Total Score	The total score of the inspection.
score_percentage	number(float) Score Percentage	The score of the inspection in percentage.
name	string Inspection Title	The name/title of the inspection.
duration	number Duration	The duration of the inspection in seconds.
authorship	Authorship
date_completed	string(date-time) Date Completed	The date and time the inspection was completed, in the format of: yyyy-MM-ddTHH:mm:ss.fffZ (UTC time).
date_modified	string(date-time) Date Modified	The date and time the inspection was last modified, in the format of: yyyy-MM-ddTHH:mm:ss.ffZ (UTC time).
date_started	string(date-time) Date Started	The date and time the inspection was started, in the format of: yyyy-MM-ddTHH:mm:ss.fffZ (UTC time).

Authorship

Summary:

Description:

Properties:

Name	Type	Summary
owner	string Inspection Owner	The user who owns the inspection.
owner_id	string Inspection Owner ID	The user ID of the inspection owner.
author	string Inspection Author	The user who created the inspection.
author_id	string Inspection Author ID	The user ID of the inspection author.

Template_data

Summary:

Description:

Properties:

Name

Type

Summary

authorship

Authorship

metadata

Metadata

Authorship

Summary:

Description:

Properties:

Name	Type	Summary
owner	string Template Owner	The user who owns the template.
owner_id	string Template Owner ID	The user ID of the template owner.
author	string Template Author	The user who created the template.
author_id	string Template Author ID	The user ID of the template author.

Metadata

Summary:

Description:

Properties:

Name

Type

Summary

description

string

Template Description

The description of the template.

name

string

Template Name

The name of the template.

GetAuditLinkResponse

Summary:

Description:

Properties:

Name

Type

Summary

url

string

Inspection Link

The inspection report link which can be viewed from a web browser.

InitExportResponse

Summary:

Description:

Properties:

Name

Type

Summary

string

Export Task ID

The unique identifier of the export task.

InitiateInspectionExportParameterFormat

Summary:

Description:

Properties:

Name

Type

Summary

format

string

Export Format

The format to export an inspection report to. Values: [PDF, WORD]

preference_id

string

Preference ID

The Report Preference to apply to the report export.

InitInspectionExportResponse

Summary:

Description:

Properties:

Name

Type

Summary

messageId

string

Export Task ID

The unique identifier of the export task.

InspectionExportStatusResponse

Summary:

Description:

Properties:

Name

Type

Summary

url

string

Export URL

The web URL to the exported inspection report file.

status

string

Export status

The current status of the export request.

modified_at

Summary: Modified

Description: Modification date filter.

Properties:

Name

Type

Summary

from

string(date-time)

After Date

Search for results modified after this date and time.

string(date-time)

Before Date

Search for results modified before this date and time.

PreferenceSearchResponse

Summary:

Description:

Properties:

Name

Type

Summary

preferences

array of (PreferencesItem)

Preferences

PreferencesItem

Summary:

Description:

Properties:

Name

Type

Summary

string

Preference ID

The unique identifier of the Report Preference.

label

string

Preference Name

The Report Preference name.

SearchActionsParameterSearchActionsBody

Summary:

Description:

Properties:

Name	Type	Summary
audit_id	array of (string) Audit ID(s)	One or more audit IDs to search for actions within.
assignees	array of (AssigneesItem) Assignees	Users assigned the action.
created_at	created_at Created	Creation date filter.
modified_at	modified_at Modified	Modification date filter.
due_at	due_at Due	Due date filter.

AssigneesItem

Summary:

Description:

Properties:

Name

Type

Summary

string

Assignee ID

The assignee's user ID or email (external).

type

string

Type

The type of assignee. Either 'user' or 'email (external)'. Values: [user, email]

SearchExportProfilesResponse

Summary:

Description:

Properties:

Name

Type

Summary

export_profiles

array of (Export_profilesItem)

Export_profilesItem

Summary:

Description:

Properties:

Name	Type	Summary
id	string Export Profile ID	The unique identifier of the Export Profile.
name	string Export Profile Name	The name of the Export Profile.
templates	array of (TemplatesItem) Template ID	The unique identifier of the template associated with the Export Profile.

TemplatesItem

Summary:

Description:

Properties:

Name

Type

Summary

string

Template ID

The unique identifier of the Template.

name

string

Template Name

The name of the Template.

TemplateSearchResponse

Summary:

Description:

Properties:

Name	Type	Summary
count	number Count	The number of templates returned as results.
total	number Total	The total number of templates found.
templates	array of (TemplatesItem) Templates

TemplatesItem

Summary:

Description:

Properties:

Name

Type

Summary

template_id

string

Template ID

The unique identifier of the template.

name

string

Template Name

The name of the template.

UpdateActionParameterUpdateActionBody

Summary:

Description:

Properties:

Name	Type	Summary
title	string Title	The text to use for the action title.
description	string Description	The text to use for the action description.
priority	string Priority	The priority to assign for the action: 0=None, 10=Low, 20=Medium, 30=High. Values: [0, 10, 20, 30]
status	string Status	The status to set for the action: 0=To Do, 10=In Progress, 50=Done, 60=Can't Do. Values: [0, 10, 50, 60]
due_at	string(date-time) Due At	The due date and time to set for the action.
assignees	array of (AssigneesItem) Assignees	Users assigned the action.

AssigneesItem

Summary:

Description:

Properties:

Name

Type

Summary

string

Assignee ID

The assignee's user ID or email (external).

type

string

Type

The type of assignee. Either 'user' or 'email (external)'. Values: [user, email]