Skip to main content
GET
/
v1
/
vendors
List Vendors
curl --request GET \
  --url https://staging-api.puppetvendors.com/v1/vendors \
  --header 'x-access-token: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://dev.puppetvendors.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Returns a list of all active (non-hidden) vendors in your shop, including their commission configuration and profile data.

​
Use Cases

  • Sync vendor roster to an external ERP, accounting tool, or spreadsheet
  • Build a vendor directory on your storefront
  • Audit commissions across all vendors at a glance
  • Power a Zapier/Make workflow that triggers when vendor data changes

​
Query Parameters

​
users
string
Set to "true" to include associated user accounts (email and user ID) for each vendor.

​
Response

200
{
  "vendors": [
    {
      "vendorId": "6157faecbebcf01bf49097d9",
      "vendorName": "acme supplies",
      "commissionType": "percentage",
      "commissionAmount": 10,
      "createdAt": "2024-01-15T08:00:00.000Z",
      "profile": [],
      "users": [
        { "_id": "61a2...", "email": "vendor@acme.com" }
      ]
    }
  ]
}
The users array is only included when ?users=true is passed. Each user object contains the _id and email of approved vendor portal accounts.

​
Example

curl -X GET "https://api.puppetvendors.com/v1/vendors?users=true" \
  -H "x-access-token: YOUR_JWT_TOKEN"