Files
GET /attachments
List files associated with an entity.
Request
- Base URLhttps://api.fergus.com
- Auth
- OAuth 2Authorization codehttps://auth.fergus.com/oauth2/authorizeToken URLhttps://auth.fergus.com/oauth2/token
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
pageSizeinteger
pageCursorstring
entityType'customer' | 'job' | 'site' | 'enquiry' | 'job_phase' | 'form' | 'certificate' required
Entity type to list attachments for. A job list also includes attachments on the job's phases, forms and certificates. form and certificate are read-only (list + download only; upload and delete are not supported).
entityIdnumber required
Entity ID to list attachments for
searchstring
Search by file name (partial match)
filterMimeTypestring
Filter by exact MIME type
filterCreatedAfterstring date-time
Filter files created after this date-time (ISO 8601)
filterCreatedBeforestring date-time
Filter files created before this date-time (ISO 8601)
filterCreatedByIdnumber
Filter by the user ID who uploaded the file
Response
Successful Response
Changes
No recorded changes to this operation across all 18 revisions of this API.