iAuditor (Preview)

iAuditor (Preview)

Fast and easy mobile inspection reporting. Get real-time visibility to uncover insights and raise standards.

iAuditor is an inspection app used to empower your workers in the field. Combined with the web platform, iAuditor provides visibility and insights to help raise safety and quality standards across an organisation. Your team can collect consistent data, standardise operations, send reports, identify failed areas and get problems resolved.

You will be prompted to enter an API token for a Premium iAuditor user account to use this integration. Tokens can be generated by following this help guide: https://support.safetyculture.com/integrations/how-to-get-an-api-token/. Find out more on https://support.safetyculture.com/integrations/.

Creating a connection

To connect your account, you will need the following information:

API Key
securestring
The API Key for your account.
Actions

Check the status of the export request submitted earlier

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

Required Parameters

Audit ID
string
The unique identifier of a specific audit.
Export Task ID
string
The ID that references the export request.

Returns

Delete an audit web report link

Delete the link to the web report of the audit.

Required Parameters

Audit ID
string
The unique identifier of a specific audit.

Returns

Download an audit report

Download the audit report submitted earlier.

Required Parameters

Audit ID
string
The unique identifier of a specific audit.
Export Task ID
string
The ID that references the export request.
Audit Report Filename
string
The filename generated by the export request.

Returns

Audit Report
binary

Audit Report as either PDF or Docx file.

Export an audit report

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

Required Parameters

Audit ID
string
The unique identifier of a specific audit.
Format
string
The format for the export.

Optional Parameters

Timezone
string
The timezone for the export.
Export Profile
string
The id of the export profile to be applied.

Returns

Generate a link to an audit

Generate a link to a specific audit that opens in iAuditor/SafetyCulture.

Required Parameters

Audit ID
string
The unique identifier of a specific audit.

Returns

Get a specific audit

Retrieve the full data contained in a single audit.

Required Parameters

Audit ID
string
The unique identifier of a specific audit.

Returns

Retrieve an audit web report link

If a link has previously been generated for this audit it is returned otherwise a new link is generated.

Required Parameters

Audit ID
string
The unique identifier of a specific audit.

Returns

Search modified audits

Retrieve the list of audits between certain dates, and search by other constraints including the source template and whether it is archived.

Optional Parameters

Sort Order
string
The datetime order in which the audits will be given.
Modified After
date-time
Audits should be last modified after this date and time.
Modified Before
date-time
Audits should be last modified before this date and time.
Filter by Template
string
Audits should be made from this template.
Archived
string
Flag indicating should audits be archived, non archived, or both.
Completed
string
Flag indicating should audits be completed, non completed, or both.
Ownership
string
Retrieve audits owned by me or shared with me by other users. Or all the audits I have access to.
Limit (Max 1000)
integer
Maximum number of entries to return.

Returns

Definitions

AuditSearchResponse

Audit ID
string
Unique identifier of the audit.
Audits
array of object
Count
number
The number of matching audits that have been returned in the search run.
Date Modified
date-time
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
Template ID
string
Unique identifier of the template.
Total
number
The total number of matching audits for the search.

GetAuditLinkResponse

Audit Link
string
The audit link which will open in SafetyCulture or iAuditor.

InitExportResponse

Export Task ID
string
Unique identifier of the export task.

ExportStatusResponse

Export Status
string
The current status of the requested export.
Export URL
string
The web URL to the completed audit export file.
Filename
string
The filename of the exported audit report.

GetAuditByIdResponse

Audit Author
string
The user who last edited the audit.
Audit Author ID
string
The user ID of the audit author.
Audit ID
string
Unique identifier of the audit.
Audit Owner
string
The user who originally created the audit.
Audit Owner ID
string
The user ID of the audit owner.
Audit Title
string
Name or title of the audit.
Date Completed
date-time
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
Date Modified
date-time
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
Date Started
date-time
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
Duration (s)
number
Duration of the audit in seconds.
Score
number
Score corresponding to the audit.
Score Percentage
float
Percent portion of the total score.
Template Author
string
The user who last edited the template.
Template Author ID
string
The user ID of the template author.
Template Description
string
Information about the template.
Template ID
string
Unique identifier of the template.
Template Name
string
Title of the template.
Template Owner
string
The user who originally created the template.
Template Owner ID
string
The user ID of the template owner.
Total Score
number
Current total score.

Limits

NameCallsRenewal Period
API calls per connection10060 seconds