---
title: "Retrieve or search attachments"
method: POST
path: "/api/workspaces/{workspaceId}/attachments/search"
tags: ["CRUD", "ItemAttachments"]
---

# Retrieve or search attachments

`POST /api/workspaces/{workspaceId}/attachments/search`

## Request

- Base URL: `https://app.airfocus.com`
- URL: `https://app.airfocus.com/api/workspaces/{workspaceId}/attachments/search`
- Auth: HTTP bearer

Returns all attachments or searches attachments by query. Always returns only attachments which are accessible by the current user.<br/>Requirements:<br/>- auth-client scopes: "workspace:read"<br/>- user permission: "read" or higher

## Path parameters

- `workspaceId` string, uuid, required

## Query parameters

- `actAsAdmin` boolean
- `offset` integer
- `limit` integer
- `from` integer
- `to` integer

## Request body

- AttachmentSearchQuery
  - `itemId` string, uuid

## Response `200`

- ItemAttachmentWithEmbedPage
  - `items` ItemAttachmentWithEmbed[], required
    - `_embedded` object, required
    - `contentType` string, required: Type of updated content.
    - `createdAt` string, date-time, required: When this attachment link has been created.
    - `id` string, uuid, required: ID of an item-attachment link.
    - `itemId` string, uuid, required: ID of the item to which the attachment is linked.
    - `lastUpdatedAt` string, date-time, required: When this attachment link has been updated for the last time.
    - `name` string, required: Name of the attachment, e.g. its file name (to be displayed in UI).
    - `uri` string, required: URI of the attachment contents. It can be any URI, but conventionally it's a relative URI like 'attachment:1ecb9ecd-8a97-403a-a74a-741eb4b8fb69' with UUID of a file uploaded to airfocus file-storage. Such URI is then resolved by clients into a full HTTPS URL.
  - `totalItems` integer, required

## Other responses

- `400`: If payload is invalid.
- `401`: If missing authentication token.
- `403`: If user does not have the required permission, or authenticated client does not have the required access scopes.
- `default`: If any other error happens.

---

[API](https://skmtc.dev/airfocus/apis/airfocus-api.md) · [All operations](https://skmtc.dev/airfocus/apis/airfocus-api/llms.txt) · [OpenAPI document](https://skmtc.dev/airfocus/apis/airfocus-api/revisions/fc9ccaa2ec6d?raw)