List inspection attachments
Returns a paginated list of inspection attachments for your company. Attachments can be either reports or additional documents. Results can be filtered by inspection and by whether the attachment is a report.
query Parameters
page[number]Page number (starts at 1)
page[size]Number of records per page (default: 200, max: 200)
filter[inspection_id]Filter by inspection ID
filter[report]Filter by whether the attachment is a report. When true, returns only attached report documents. When false, returns only additional documents. This is orthogonal to the attachment_type category.
sortSort field. Prefix with '-' for descending order. Supported values: created_at
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List inspection attachments › Responses
Inspection attachments retrieved successfully
Pagination metadata
Pagination links
Upload an inspection attachment
Uploads a new attachment for an inspection. The request must be sent as multipart/form-data because a file upload is required. Pass data in key-value entries with the key formatted as data[attributes][field-name]. For the file, use data[attributes][file] and include the file as the value.
Supported file types: images (jpg, jpeg, png, gif), PDF, ZIP, plain text, audio (mp3), Word, Excel, and PowerPoint documents.
data[attributes][attachment_type] is required and declares the category of the file being uploaded. See the attachment_type enum on the request schema below for the accepted values; anything else is rejected with a 422.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Upload an inspection attachment › Responses
Inspection attachment uploaded successfully