Skip to main content
GET
/
v2
/
vendors
/
{vendorId}
Get Vendor
curl --request GET \
  --url https://api.puppetvendors.com/v2/vendors/{vendorId} \
  --header 'x-access-token: <api-key>'
V2 Alpha — This endpoint is part of the V2 API preview. Breaking changes may occur.

​
Overview

Retrieve detailed information for a single vendor, including their commission configuration and profile. Optionally include associated user accounts with the includeUsers query parameter.

​
Use Cases

  • Vendor detail views — Display full vendor information in custom UIs
  • Commission review — Check a vendor’s commission setup
  • User management — List user accounts linked to a vendor

​
Path Parameters

​
vendorId
string
required
The vendor’s MongoDB ObjectId.

​
Query Parameters

​
includeUsers
boolean
default:"false"
Include associated user accounts in the response.

​
Response

200
{
  "success": true,
  "data": {
    "vendor": {
      "_id": "507f1f77bcf86cd799439011",
      "vendorName": "Acme Supplies",
      "vendorNameAlias": "acme-supplies",
      "commissionType": "percentage",
      "commissionAmount": 14,
      "reportingEmail": "reports@acmesupplies.com",
      "isHidden": false,
      "profile": {
        "fields": [
          { "field": "Company Registration", "value": "12345678" },
          { "field": "Website", "value": "https://acmesupplies.com" }
        ]
      },
      "createdAt": "2024-03-10T08:00:00.000Z",
      "updatedAt": "2024-06-15T10:30:00.000Z"
    }
  }
}

​
Error Response

404
{
  "success": false,
  "error": {
    "message": "Vendor not found",
    "code": "NOT_FOUND"
  }
}

​
Example

curl -X GET "https://api.puppetvendors.com/v2/vendors/507f1f77bcf86cd799439011?includeUsers=true" \
  -H "x-access-token: YOUR_JWT_TOKEN"