Search modified inspections

The inspection search endpoint allows you to retrieve the inspection ID, modification date, and template ID of inspections that meet a certain criteria. It is possible to request inspections between given dates, based on a particular template, and whether or not to include archived inspections.

This allows you to find particular inspections, to gradually retrieve the inspection IDs of every inspection that you have access to, or to retrieve inspections updated since your last search.

In the request, you must specify the fields that you want to return. The field audit_id is not required, the inspection ID will be always included in every inspection result returned in the response.

To include other inspection properties in the response you can optionally add parameters modified_at and template_id. Multiple field elements can be provided.

Dates must be formatted according to ISO 8601 date and time format. For example,
2015-04-01T00:00:00.000Z or 2015-04-01T00:00+1000.

🚧

The modification dates used for searching are related to SafetyCulture's cloud storage and include latest sync times, modifications through the SafetyCulture website, and other system modifications. This means that the date may not match the last date that the inspection was modified. This will ensure that you may consistently find all of the inspections modified since your last search, even if they are synced some time after they are last changed.

Searching by template allows you to find all of the inspections created from a certain template. You may specify one or more template parameters to search for. The template ID can be obtained from an inspection, or by opening it for editing via the web app.

Query Params
field
array of strings

The fields to return. Defaults to just audit_id.

  • audit_id: Include audit_id in the response.
  • modified_at: Include modified_at in the response.
  • template_id: Include template_id in the response.
field
Allowed:
string
enum
Defaults to asc

The order to return results in.

  • asc: Ascending order.
  • desc: Descending order.
Allowed:
date-time

Filter inspections modified after this date time.

date-time

Filter inspections modified before this date time.

template
array of strings

Filter to inspections conducted from these templates.

template
string
enum
Defaults to false

Filter results by archived status. Default is false.

  • false: Only unarchived inspections.
  • true: Only archived inspections.
  • both: Both unarchived and archived inspections.
Allowed:
string
enum
Defaults to both

Filter results by completed status. Default is both.

  • both: Both complete and incomplete inspections.
  • false: Only incomplete inspections.
  • true: Only complete inspections.
Allowed:
string
enum
Defaults to all

Filter results by owner. Default is all.

  • all: Owned by anyone.
  • me: Only owned by the requesting user
  • other: Only owned by other users.
Allowed:
int32

Limit the number of results returned. Default is 100.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json