v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB
Inspections

Search modified inspections

get/audits/search

Query parameters

fieldstring[]

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.
order'asc' | 'desc'

The order to return results in.

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

Filter inspections modified after this date time.

modified_beforestring date-time

Filter inspections modified before this date time.

templatestring[]

Filter to inspections conducted from these templates.

archived'false' | 'true' | 'both'

Filter results by archived status. Default is false.

  • false: Only unarchived inspections.
  • true: Only archived inspections.
  • both: Both unarchived and archived inspections.
completed'both' | 'false' | 'true'

Filter results by completed status. Default is both.

  • both: Both complete and incomplete inspections.
  • false: Only incomplete inspections.
  • true: Only complete inspections.
owner'all' | 'me' | 'other'

Filter results by owner. Default is all.

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

Limit the number of results returned. Default is 100.

Response

A successful response.

countinteger

The number of results returned.

totalinteger

The total number of results available.