Get Document Configurations

Method: GET
/api/v1/document-configurations

---

Description

This endpoint retrieves a list of document configurations based on various filters such as document type, country, uploader, and configuration name. It allows sorting and pagination for better control of results.

---

🔑 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
documentUploadedBy	string	Filter by who uploaded the document (ALL, SELLER, BUYER, ADMIN).
byTradeType	string	Filter by trade type.
byCountry	string	Filter by country.
byConfigName	string	Filter by document configuration name.
byDocumentCategoryIds	string	Filter by document category IDs.
documentConfigurationActive	string	Filter by document configuration status (0 for inactive, 1 for active).
byDocumentType	string	Filter by document type (PRODUCT, TRADE), comma-separated if multiple.
order	string	Sort results (ASC for ascending, DESC for descending).
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 configurations.

Example Response:

[
  {
    "configId": "12345",
    "configName": "Trade Documents",
    "documentType": "TRADE",
    "uploadedBy": "SELLER",
    "country": "Nigeria",
    "isActive": true,
    "createdAt": "2025-02-12T10:00:00Z"
  },
  {
    "configId": "67890",
    "configName": "Product Documents",
    "documentType": "PRODUCT",
    "uploadedBy": "ADMIN",
    "country": "Kenya",
    "isActive": false,
    "createdAt": "2025-01-15T12:00:00Z"
  }
]