---
title: "Search documentation documents (Supplier)"
method: POST
path: "/api/v{version}/documents/search"
tags: ["documentation"]
---

# Search documentation documents (Supplier)

`POST /api/v{version}/documents/search`

## Request

- Base URL: `https://api.zrexpress.app`
- URL: `https://api.zrexpress.app/api/v{version}/documents/search`
- Auth: HTTP bearer and API key in header `X-Api-Key`

Search and filter active documentation documents with pagination. Only returns documents that are visible to suppliers. Use Keyword for text search or AdvancedFilter for complex filtering.

## Path parameters

- `version` string, required

## Headers

- `X-Tenant` string, required

## Request body

- SearchSupplierDocumentsRequest
  - `advancedSearch` Search
    - `fields` string[], nullable
    - `keyword` string, nullable
  - `keyword` string, nullable
  - `advancedFilter` Filter
    - `logic` string, nullable
    - `filters` Filter[], nullable
    - `field` string, nullable
    - `operator` string, nullable
    - `value` unknown
  - `pageSize` integer
  - `pageNumber` integer
  - `orderBy` string[], nullable

## Response `200`

OK

- PagedListSearchSupplierDocumentResponse
  - `items` SearchSupplierDocumentResponse[], nullable
    - `id` string, uuid
    - `title` string, nullable
    - `description` string, nullable
    - `fileId` string, uuid
    - `type` string, nullable
    - `category` string, nullable
    - `displayOrder` integer
    - `createdAt` string, date-time
    - `sasUrl` string, uri, nullable
    - `fileName` string, nullable
    - `mimeType` string, nullable
  - `pageNumber` integer
  - `pageSize` integer
  - `totalCount` integer
  - `totalPages` integer
  - `hasPrevious` boolean
  - `hasNext` boolean

## Other responses

- `400`: Bad Request

## Changes

- **2026-11-03** `652262902df9`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zrexpress/apis/zrexpress-api/changes/api/v:version/documents/search/post.md)

---

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