Skip to main content
GET
List Vendors

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

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

Response

200
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