---
title: "Search Files"
method: GET
path: "/dam/search"
tags: ["DAM: Search"]
---

# Search Files

`GET /dam/search`

## Request

- Base URL: `https://api.kontainer.com/jsonapi/v2`
- URL: `https://api.kontainer.com/jsonapi/v2/dam/search`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/kontainer/apis/kontainer-api-documentation/docs/dam/search/get.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to search files. One or multiple filters can be applied. <br/>**Note: The result set is lmited to 10,000 results.**

## Query parameters

- `filter[keywords][like]` string
- `filter[keywords][in][]` string[]
- `filter[extensions][in][]` string[]
- `filter[custom_fields]` object
- `filter[custom_fields_category_id][eq]` integer
- `filter[upload_date][gte]` string
- `filter[upload_date][lte]` string
- `filter[updated_date][gte]` string
- `filter[updated_date][lte]` string
- `filter[start_folder][eq]` integer
- `filter[folder_id][eq]` integer
- `page[size]` integer
- `page[number]` integer
- `sort` string
- `content_matches` boolean
- `relationships` string
- `includes` string

## Response `200`

success

- SearchResponse
  - `data` union[]
    - union
      - File
        - `type` 'file', required
        - `id` string, required
        - `attributes` FileAttributes, required
          - `name` string
          - `description` string, nullable
          - `size` integer: File size in bytes
          - `sort` integer
          - `created_at` string, date-time
          - `updated_at` string, date-time, nullable
          - `extension` string
          - `width` integer, nullable: Width of the stored pixels, before EXIF orientation is applied
          - `height` integer, nullable: Height of the stored pixels, before EXIF orientation is applied
          - `orientation` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8: EXIF orientation code (1-8). 1 when the file has no orientation tag. Codes 5-8 display with width and height swapped
          - `rotation` 0 | 90 | 180 | 270: Clockwise degrees the EXIF orientation turns the stored pixels to display them. 90 and 270 swap width and height
          - `version` integer
          - `is_archived` boolean
          - `hasDuplicates` boolean
          - `consent_status` string
          - `consent_rights` string[]
          - `consent_party_ids` integer[]
          - `consent_expire_at` string, date-time, nullable
      - Folder
        - `type` 'folder', required
        - `id` string, required
        - `attributes` FolderAttributes, required
          - `name` string
          - `description` string
          - `created_at` string, date-time
          - `updated_at` string, date-time
          - `sort` integer
          - `child_count` integer
          - `files_count` integer
          - `files_size` integer
          - `path` string
          - `show_large_folder_name` boolean
          - `hide_folder_name` boolean
          - `thumbs_scale_to_fit` boolean
          - `apply_folder_image_hue` boolean
          - `is_archived` boolean
          - `is_synced_mirror` boolean, nullable: Only present on mirror folders
          - `mirror_design` boolean: Only present on mirror folders
        - `relationships` FolderRelationships
          - `folder_thumbnail_file` object, nullable
            - `data` ResourceIdentifierObject
              - …
        - `links` FolderLinks
          - `self` string, uri
        - `meta` FolderMeta
          - `folder_type` 'folder' | 'album' | 'smart_folder' | 'mirror_folder' | 'archive_folder'
          - `is_locked` boolean
  - `meta` SearchMeta
    - `filter` union, required: The `filter` query parameter echoed back as sent; an empty array when none was sent
      - object
      - unknown[]
        - unknown
    - `sort` string, nullable, required: The `sort` query parameter echoed back; null when none was sent
    - `content_matches` object: Present only when `content_matches` was sent: by file id, up to three passages of the file text holding the keywords, the passage holding the most of them first. Files whose text held none are left out.
  - `pagination` PaginationMeta
    - `total` integer, required
    - `per_page` integer, required
    - `current_page` integer, required
    - `last_page` integer, required
    - `info` string: Present only when the result set hit the 10,000 record cap

## Other responses

- `401`: Unauthorized

---

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