Find Inspections

Use GET /v3/inspections to search, filter, sort, and paginate inspections in your organization.

Every search is done through the query string. Use filter[q][=] for free-text search, filter[field][operator] for exact filters, sort[field]=asc|desc for ordering, and page[number] / page[size] for pagination. All of these are optional, and you can combine them to find the exact inspections you need.

Example

1. Start with the inspections endpoint.

   Text

   GET https://vision-api.truepic.com/v3/inspections

2. Add filter[q][=] when you want to search across several fields with one query.

   Text

   https://vision-api.truepic.com/v3/inspections?filter[q][=]=jane%20doe

3. Add exact filters with filter[field][operator] when you know the field you want to match.

   Text

   https://vision-api.truepic.com/v3/inspections?filter[created_at][>=]=2023-06-01

4. Add sorting and pagination to control the result order and page size.

   Text

   https://vision-api.truepic.com/v3/inspections?sort[created_at]=desc&page[number]=1&page[size]=25

You can combine free-text search, exact filters, sorting, and pagination in the same request.

Search

filter[q][=] is a free-text search parameter (a query that checks several inspection fields at once).

It can match:

• customer_name
• customer_first_name
• customer_last_name
• customer_email_address
• address
• custom_field_values
• the beginning of the inspection ID
• the customer phone number when your search term is numeric

Use these rules when building search queries:

• Search is case-insensitive for text fields.
• If you pass multiple terms, each term must match somewhere on the inspection.
• Terms shorter than 2 characters are ignored.
• For numeric terms, the query also attempts to match the customer phone number using the digits from your search value.
• filter[q][=] accepts strings up to 100 characters.

Examples:

# Search by customer name
https://vision-api.truepic.com/v3/inspections?filter[q][=]=Jane%20Doe

# Search by email address
https://vision-api.truepic.com/v3/inspections?filter[q][=][email protected]

# Search by phone number
https://vision-api.truepic.com/v3/inspections?filter[q][=]=5551234567

# Search by inspection ID prefix
https://vision-api.truepic.com/v3/inspections?filter[q][=]=10234

Filter

Use exact filters when you want to narrow results to known IDs, dates, counts, photo upload status, or custom field values.

ID, status, and custom field filters

For any in filter, repeat the query string key for each value:

https://vision-api.truepic.com/v3/inspections?filter[status][in][]=2&filter[status][in][]=3

Date filters

updated_at is the timestamp for the inspection document in the database. It changes when the inspection record changes, but it does not necessarily change when an inspection is completed or when a new photo is uploaded. To find inspections with the most recent photo activity, sort by photos and filter out inspections without photos.

You can build ranges by combining the same field with multiple operators in one request:

https://vision-api.truepic.com/v3/inspections?filter[created_at][>=]=2024-01-01&filter[created_at][<]=2024-02-01

Sort

Use sort[field]=asc or sort[field]=desc to control the order of the results.

If you do not pass a sort field, the endpoint defaults to created_at.

Paginate

Common recipes

Find inspections created after a date

https://vision-api.truepic.com/v3/inspections?filter[created_at][>=]=2023-06-01

Find inspections created within a date range

https://vision-api.truepic.com/v3/inspections?filter[created_at][>=]=2024-01-01&filter[created_at][<]=2024-02-01

Find inspections most recently updated with new photos

Use sort[photos]=desc with filter[photos][is not]=null to return inspections that have photos, ordered by the most recent photo upload. The photos sort maps to the photo_uploaded_last property returned with each inspection.

https://vision-api.truepic.com/v3/inspections?sort[photos]=desc&filter[photos][is%20not]=null

Find inspections with one or more alerts

https://vision-api.truepic.com/v3/inspections?filter[alert_count][>]=0&sort[alert_count]=desc

Search across customer and address fields

https://vision-api.truepic.com/v3/inspections?filter[q][=]=jane%20doe

Search by phone number

https://vision-api.truepic.com/v3/inspections?filter[q][=]=5551234567

Combine free-text search with team and status filters

https://vision-api.truepic.com/v3/inspections?filter[q][=]=smith&filter[team_id][in][]=12&filter[status][in][]=2&filter[status][in][]=3

Filter by an exact custom field value

https://vision-api.truepic.com/v3/inspections?filter[custom_field_3][=]=ABC-123

Find inspections assigned to a member and scheduled before a date

https://vision-api.truepic.com/v3/inspections?filter[assigned_to_member][in][]=42&filter[scheduled_for][<]=2024-12-31

Sort newest first and return 25 results from page 2

https://vision-api.truepic.com/v3/inspections?sort[created_at]=desc&page[number]=2&page[size]=25

Compare queries with the Vision Dashboard

We recommend comparing search results with the Vision Dashboard and watching how the URL changes as you apply filters. That is a quick way to understand which query string parameters to send from your integration. The dashboard uses the same filtering query string, so you can filter and search for the inspections you need, copy the query string, and use it with the Vision API to return the same inspections.

For the full endpoint details and to test queries interactively, see Inspections > Get a list of existing inspection requests.