Skip to main content

Get distributors list

GET /v1/distributor

Retrieves a paginated list of distributors for the authenticated tenant. Each distributor object includes key details such as name, status, address, and assigned product count. This endpoint supports pagination through metadata fields like total count, current page, and items per page.

Query Parameters​

  • populate[] - Parameter for populate[]
  • ~perPage - Parameter for ~perPage
  • ~page - Parameter for ~page

Request Example​

GET /v1/distributor?populate[]=assignedProductsCount

Response Example​

{
  "distributors": [
    {
      "address": {
        "line2": "",
        "street": "",
        "zip": "",
        "city": "",
        "country": "",
        "state": ""
      },
      "_id": "distributor-id-1",
      "name": "Example Distributor 1",
      "tenant": "tenant-id-1",
      "active": true,
      "created": "2025-10-21T15:00:59.342Z",
      "updated": "2025-10-21T15:00:59.342Z",
      "assignedProductsCount": 0
    },
    {
      "address": {
        "line2": "",
        "street": "",
        "zip": "",
        "city": "",
        "country": "",
        "state": ""
      },
      "_id": "distributor-id-2",
      "name": "Example Distributor 2",
      "tenant": "tenant-id-1",
      "active": false,
      "created": "2025-06-20T08:13:21.836Z",
      "updated": "2025-06-20T08:13:21.836Z",
      "assignedProductsCount": 5
    }
  ],
  "metadata": {
    "totalCount": 2,
    "page": 0,
    "perPage": 25
  }
}