---
title: "GET /attachments"
method: GET
path: "/attachments"
tags: ["Files"]
---

# GET /attachments

`GET /attachments`

List files associated with an entity.

## Query parameters

- `pageSize` integer
- `sortOrder` union
  - 'asc'
  - 'desc'
- `pageCursor` string
- `entityType` 'customer' | 'job' | 'site' | 'enquiry' | 'job_phase' | 'form' | 'certificate', required
- `entityId` number, required
- `search` string
- `filterMimeType` string
- `filterCreatedAfter` string, date-time
- `filterCreatedBefore` string, date-time
- `filterCreatedById` number

## Response `200`

Successful Response

- ListFilesResponse
  - `result` string, required
  - `data` File[], required
    - `id` number, required
    - `companyId` number, required
    - `entityType` 'customer' | 'job' | 'site' | 'enquiry' | 'job_phase' | 'form' | 'certificate', required
    - `entityId` number, required
    - `fileGuid` string, required — Unique file identifier (sys_file.guid)
    - `fileName` string, required
    - `fileSize` number, required — File size in bytes
    - `mimeType` string, required
    - `createdBy` number, nullable, required
    - `createdAt` string, date-time, required
    - `links` Links[], required
      - `href` string, required
      - `rel` string, required
      - `type` 'GET' | 'POST' | 'PUT' | 'PATCH', required
  - `paging` Pagination
    - `perPage` number, required
    - `pageCount` number, required
    - `links` object, required
      - `self` string, required
      - `previous` string, nullable, required
      - `next` string, nullable, required

## Other responses

- `4XX` — Client Request Errors
- `5XX` — Server Errors

---

[API](https://skmtc.dev/fergus/apis/fergus-api.md) · [All operations](https://skmtc.dev/fergus/apis/fergus-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fergus/fergus-api/revisions/b4f232a22363/schema)