---
title: "Find attachments based on search parameters."
method: POST
path: "/api/attachments/list"
tags: ["Attachment"]
---

# Find attachments based on search parameters.

`POST /api/attachments/list`

## Query parameters

- `Sort.Field` string
- `Sort.Dir` 'ascending' | 'descending' — Specify sorting direction.
- `Skip` integer
- `Take` integer

## Request body

- AttachmentRequestFindParameters — Parameters used for searching/finding attachmewnts. Note: These filters are applied using the AND operator. If both attachmentIds and owner are provided, attachments that do match the owner will not be returned.
  - `owner` AttachmentOwnerDto — Attachment owner
    - `type` 'salesOrder' | 'salesOrderReceiving' | 'salesOrderPartLineItem' | 'quote' | 'quotePartLineItem' | 'purchaseOrder' | 'purchaseOrderReceiving' | 'purchaseOrderPartLineItem' | 'invoice' | 'workOrderOperation' | 'operation' | 'inventoryLot' | 'item' | 'job' — Owner types
    - `id` string — The primary owner id of this attachment.
  - `owners` AttachmentOwnerDto[], nullable — The primary owners of the attachment.
    - `type` 'salesOrder' | 'salesOrderReceiving' | 'salesOrderPartLineItem' | 'quote' | 'quotePartLineItem' | 'purchaseOrder' | 'purchaseOrderReceiving' | 'purchaseOrderPartLineItem' | 'invoice' | 'workOrderOperation' | 'operation' | 'inventoryLot' | 'item' | 'job' — Owner types
    - `id` string — The primary owner id of this attachment.
  - `attachmentIds` string[], nullable — Filter to attachments whose ids are in the list.
  - `formats` CommonEnumAttachmentMediaFormatEnum[], nullable — Allows for filtering based on specific attachment format types.

## Response `200`

List of attachments matching the filters

- AttachmentDto[]
  - `id` string, required — Unique Id associated to this entity
  - `owner` AttachmentOwnerDto, required — Attachment owner
    - `type` 'salesOrder' | 'salesOrderReceiving' | 'salesOrderPartLineItem' | 'quote' | 'quotePartLineItem' | 'purchaseOrder' | 'purchaseOrderReceiving' | 'purchaseOrderPartLineItem' | 'invoice' | 'workOrderOperation' | 'operation' | 'inventoryLot' | 'item' | 'job' — Owner types
    - `id` string — The primary owner id of this attachment.
  - `name` string, nullable — The file name.
  - `description` string, nullable — Description
  - `type` 'standard' | 'externalAccessDocument' | 'certification' — Attachment types
  - `format` 'undefined' | 'cad' | 'document' | 'image' | 'video' — Attachment format
  - `size` integer, nullable — File size in bytes
  - `fileId` string, required — Internal file identifier
  - `createdUtc` string, date-time — UTC timestamp when this attachment record was created on its current owner. Note: when an attachment is copied between owners (for example, from a quote to a job), a new attachment record is created and this value reflects the copy time, not the original upload time.

---

[API](https://skmtc.net/fulcrumpro/apis/fulcrum-publicapi.md) · [All operations](https://skmtc.net/fulcrumpro/apis/fulcrum-publicapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fulcrumpro/fulcrum-publicapi/versions/1b5649cff14a/schema)