Get Document Categories

Method: GET
/api/v1/document-category

---

Description

This endpoint retrieves a list of document categories based on the provided filters. Document categories may be categorized by types such as PRODUCT or TRADE, and can be filtered by tenant, date range, or other parameters.

---

🔑 Authentication

This endpoint requires authentication via headers.

Param	Value	Type
tenantId	{{tenantId}}	string
userId	{{userId}}	string
countryCode	{{countryCode}}	string (optional)

---

Query Parameters

Name	Type	Description
documentCategorySearch	string	Search for document categories by name or keyword.
documentCategoryDateRange	string	Filter document categories by date range (e.g., 2020-11-12,2022-11-15).
byTenantIds	string	Filter by tenant IDs (comma-separated).
byCategoryType	string	Filter by category types (PRODUCT, TRADE).
order	string	Sort results in ascending (ASC) or descending (DESC) order.
page	string	Specify the page number for paginated results.
limit	string	Specify the number of results per page.

---

Response: 200 OK

A successful response returns a list of document categories along with their details.

Example Response:

[
  {
    "documentCategoryId": "12345",
    "name": "Product Documents",
    "type": "PRODUCT",
    "createdAt": "2025-02-12T04:04:39.986Z",
    "tenantId": "tenant123"
  },
  {
    "documentCategoryId": "67890",
    "name": "Trade Documents",
    "type": "TRADE",
    "createdAt": "2025-02-11T08:20:15.000Z",
    "tenantId": "tenant456"
  }
]