iAuditor (Preview)

iAuditor (Preview)

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

Note:

  • This is a Premium connector.

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/.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

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 an export task.

Returns

Create an Action

Create an Action

Optional Parameters

Audit ID
string
Audit ID
Item ID
string
Item ID
Description
string
The text to use for the action description.
Priority
string
Priority: 0=None, 10=Low, 20=Med, 30=High
Status
string
Status: 0=To Do, 10=In Progress, 50=Done, 60=Cannot Do
Due At
date-time
Due At
ID
string
Assignee user id or email
Type
string
The type of assignee. Either 'user' or 'email'.

Returns

Body
action

Delete an Action

Delete an Action

Required Parameters

Action ID
string
The unique identifier of a specific action.

Returns

ok
boolean
ok

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 an export task.
Audit Report Filename
string
The filename generated by an 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 to generate an export in.

Optional Parameters

Timezone
string
The timezone to use when generating an export.
Export Profile
string
The ID of the export profile to generate an export with.

Returns

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

Get an image within an audit

Get an image within an audit

Required Parameters

Audit ID
string
The unique identifier of a specific audit.
Image ID
string
The unique identifier of a specific image.

Returns

Image File
binary

The image within an audit

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 actions

Find actions related based upon their status, priority, assignees, item, audit and more.

Optional Parameters

Audit ID(s)
string
The unique identifier for the audits to search against.
ID
string
Assignee user id or email
Type
string
The type of assignee. Either 'user' or 'email'.
After Date
date-time
Search for results created after this date and time.
Before Date
date-time
Search for results created before this date and time.
After Date
date-time
Search for results modified after this date and time.
Before Date
date-time
Search for results modified before this date and time.
After Date
date-time
Search for results due after this date and time.
Before Date
date-time
Search for results due before this date and time.

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 results will be given.
Modified After
date-time
Filter to include results last modified after this date and time.
Modified Before
date-time
Filter to include results last modified before this date and time.
Filter by Template
string
Filter to include results from a specific template.
Archived
string
Filter to include only archived (true), non-archived (false), or both.
Completed
string
Filter results to include only complete, incomplete, or both.
Ownership
string
Retrieve results owned by me or shared with me by other users. Or all that I have access to.
Limit (Max 1000)
integer
Maximum number of results to return.

Returns

Set the archived state of an audit

Choose 'Yes' to archive an audit and 'No' to restore an archived audit.

Required Parameters

Audit ID
string
The unique identifier of a specific audit.

Optional Parameters

Archived
boolean
Yes/No

Returns

Update an Action

Update an Action

Required Parameters

Action ID
string
The unique identifier of a specific action.

Optional Parameters

Description
string
The text to use for the action description.
Priority
string
Priority: 0=None, 10=Low, 20=Med, 30=High
Status
string
Status: 0=To Do, 10=In Progress, 50=Done, 60=Cannot Do
Due At
date-time
Due At
ID
string
Assignee user id or email
Type
string
The type of assignee. Either 'user' or 'email'.

Returns

Body
action

Definitions

action_id

The ID of the action.

count

The number of matching results that have been returned in the current search run.

total

The overall total number of matching results for the search.

offset

The offset/page of the current set of results.

AuditSearchResponse

Audit ID
string
Unique identifier of the audit.
Audits
array of object
Count
count
The number of matching results that have been returned in the current search run.
Date Modified
date-time
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)
Template ID
string
Unique identifier of the template.
Total
total
The overall total number of matching results 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.

ActionsSearchResponse

Actions
array of action
Actions
Count
count
The number of matching results that have been returned in the current search run.
Offset
offset
The offset/page of the current set of results.
Total
total
The overall total number of matching results for the search.

action

Action ID
action_id
The ID of the action.
Assignees
array of object
The assignees of the action.
Completion Date
date-time
The date and time the action was completed.
Creation Date
date-time
The date and time the action was created.
Creator's ID
string
The ID of the user who created the action.
Creator's Name
string
The name of the user who created the action.
Description
string
description
Due Date
date-time
The date and time the action was due.
ID
string
The item's identifier.
ID
string
The ID of the action assignee.
ID
string
The ID of the audit.
Label
string
The item's label.
Modification Date
date-time
The date and time the action was last modified.
Name
string
The name of the audit.
Name
string
The name of the action assignee.
Priority
integer
The priority of the action.
Status
integer
The status of the action.
Type
string
The ID type of the assignee (user ID or email address).