iAuditor (Preview)

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

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Contact
Name SafetyCulture Support
URL https://www.safetyculture.com/contact-us
Email support@safetyculture.com
Connector Metadata
Publisher SafetyCulture
Website https://safetyculture.com/iauditor/
Privacy policy https://safetyculture.com/legal/privacy-policy/

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:

Name Type Description
API Key securestring

The API Key for your account.

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Check the status of the export request submitted earlier

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

Create an Action

Create an Action

Delete an Action

Delete an Action

Delete an audit web report link

Delete the link to the web report of the audit.

Download an audit report

Download the audit report submitted earlier.

Export an audit report

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

Generate a link to an audit

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

Get a specific audit

Retrieve the full data contained in a single audit.

Get an image within an audit

Get an image within an audit

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.

Search actions

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

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.

Set the archived state of an audit

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

Update an Action

Update an Action

Check the status of the export request submitted earlier

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

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific audit.

Export Task ID
exportId True string

The ID that references an export task.

Returns

Create an Action

Create an Action

Parameters

Name Key Required Type Description
Audit ID
audit_id string

Audit ID

Item ID
item_id string

Item ID

Description
description string

The text to use for the action description.

Priority
priority string

Priority: 0=None, 10=Low, 20=Med, 30=High

Status
status string

Status: 0=To Do, 10=In Progress, 50=Done, 60=Cannot Do

Due At
due_at date-time

Due At

ID
id string

Assignee user id or email

Type
type string

The type of assignee. Either 'user' or 'email'.

Returns

Body
action

Delete an Action

Delete an Action

Parameters

Name Key Required Type Description
Action ID
actionId True string

The unique identifier of a specific action.

Returns

Name Path Type Description
ok
ok boolean

ok

Delete the link to the web report of the audit.

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific audit.

Download an audit report

Download the audit report submitted earlier.

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific audit.

Export Task ID
exportId True string

The ID that references an export task.

Audit Report Filename
filename True string

The filename generated by an export request.

Returns

Audit Report as either PDF or Docx file.

Audit Report
binary

Export an audit report

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

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific audit.

Format
format True string

The format to generate an export in.

Timezone
timezone string

The timezone to use when generating an export.

Export Profile
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.

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific audit.

Returns

Get a specific audit

Retrieve the full data contained in a single audit.

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific audit.

Returns

Get an image within an audit

Get an image within an audit

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific audit.

Image ID
mediaId True string

The unique identifier of a specific image.

Returns

The image within an audit

Image File
binary

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

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific audit.

Returns

Search actions

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

Parameters

Name Key Required Type Description
Audit ID(s)
Audit ID(s) string

The unique identifier for the audits to search against.

ID
id string

Assignee user id or email

Type
type string

The type of assignee. Either 'user' or 'email'.

After Date
from date-time

Search for results created after this date and time.

Before Date
to date-time

Search for results created before this date and time.

After Date
from date-time

Search for results modified after this date and time.

Before Date
to date-time

Search for results modified before this date and time.

After Date
from date-time

Search for results due after this date and time.

Before Date
to 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.

Parameters

Name Key Required Type Description
Sort Order
order string

The datetime order in which the results will be given.

Modified After
modified_after date-time

Filter to include results last modified after this date and time.

Modified Before
modified_before date-time

Filter to include results last modified before this date and time.

Filter by Template
template string

Filter to include results from a specific template.

Archived
archived string

Filter to include only archived (true), non-archived (false), or both.

Completed
completed string

Filter results to include only complete, incomplete, or both.

Ownership
owner string

Retrieve results owned by me or shared with me by other users. Or all that I have access to.

Limit (Max 1000)
limit 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.

Parameters

Name Key Required Type Description
Audit ID
auditId True string

The unique identifier of a specific audit.

Archived
archived boolean

Yes/No

Returns

Update an Action

Update an Action

Parameters

Name Key Required Type Description
Action ID
actionId True string

The unique identifier of a specific action.

Description
description string

The text to use for the action description.

Priority
priority string

Priority: 0=None, 10=Low, 20=Med, 30=High

Status
status string

Status: 0=To Do, 10=In Progress, 50=Done, 60=Cannot Do

Due At
due_at date-time

Due At

ID
id string

Assignee user id or email

Type
type string

The type of assignee. Either 'user' or 'email'.

Returns

Body
action

Definitions

action_id

The ID of the action.

The ID of the action.

Action ID
string

count

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

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

Count
number

total

The overall total number of matching results for the search.

The overall total number of matching results for the search.

Total
number

offset

The offset/page of the current set of results.

The offset/page of the current set of results.

Offset
number

AuditSearchResponse

Name Path Type Description
Count
count count

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

Total
total total

The overall total number of matching results for the search.

Audits
audits array of object
Audit ID
audits.audit_id string

Unique identifier of the audit.

Date Modified
audits.modified_at date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Template ID
audits.template_id string

Unique identifier of the template.

GetAuditLinkResponse

Name Path Type Description
Audit Link
url string

The audit link which will open in SafetyCulture or iAuditor.

InitExportResponse

Name Path Type Description
Export Task ID
id string

Unique identifier of the export task.

ExportStatusResponse

Name Path Type Description
Export Status
status string

The current status of the requested export.

Export URL
href string

The web URL to the completed audit export file.

Filename
filename string

The filename of the exported audit report.

GetAuditByIdResponse

Name Path Type Description
Template ID
template_id string

Unique identifier of the template.

Audit ID
audit_id string

Unique identifier of the audit.

Score
audit_data.score number

Score corresponding to the audit.

Total Score
audit_data.total_score number

Current total score.

Score Percentage
audit_data.score_percentage float

Percent portion of the total score.

Audit Title
audit_data.name string

Name or title of the audit.

Duration (s)
audit_data.duration number

Duration of the audit in seconds.

Audit Owner
audit_data.authorship.owner string

The user who originally created the audit.

Audit Owner ID
audit_data.authorship.owner_id string

The user ID of the audit owner.

Audit Author
audit_data.authorship.author string

The user who last edited the audit.

Audit Author ID
audit_data.authorship.author_id string

The user ID of the audit author.

Date Completed
audit_data.date_completed date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Date Modified
audit_data.date_modified date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Date Started
audit_data.date_started date-time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

Template Owner
template_data.authorship.owner string

The user who originally created the template.

Template Owner ID
template_data.authorship.owner_id string

The user ID of the template owner.

Template Author
template_data.authorship.author string

The user who last edited the template.

Template Author ID
template_data.authorship.author_id string

The user ID of the template author.

Template Description
template_data.metadata.description string

Information about the template.

Template Name
template_data.metadata.name string

Title of the template.

ActionsSearchResponse

Name Path Type Description
Count
count count

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

Total
total total

The overall total number of matching results for the search.

Offset
offset offset

The offset/page of the current set of results.

Actions
actions array of action

Actions

action

Name Path Type Description
Action ID
action_id action_id

The ID of the action.

ID
audit.audit_id string

The ID of the audit.

Name
audit.name string

The name of the audit.

ID
item.item_id string

The item's identifier.

Label
item.label string

The item's label.

Description
description string

description

Priority
priority integer

The priority of the action.

Status
status integer

The status of the action.

Assignees
assignees array of object

The assignees of the action.

ID
assignees.id string

The ID of the action assignee.

Name
assignees.name string

The name of the action assignee.

Type
assignees.type string

The ID type of the assignee (user ID or email address).

Creator's ID
created_by.user_id string

The ID of the user who created the action.

Creator's Name
created_by.name string

The name of the user who created the action.

Creation Date
created_at date-time

The date and time the action was created.

Modification Date
modified_at date-time

The date and time the action was last modified.

Due Date
due_at date-time

The date and time the action was due.

Completion Date
completed_at date-time

The date and time the action was completed.

binary

This is the basic data type 'binary'.