VUZDevelopers

List suppliers with optional filters and pagination

GET
/suppliers

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Query Parameters

search?string

Search by name (Hebrew or English)

businessNumber?string

Filter by business number

categoryId?string

Filter by category ID

favoritesOnly?string

Filter favorites only ("true"/"false")

Default"false"
activeOnly?string

Filter active only ("true"/"false")

Default"true"
page?number

Page number

Range1 <= value
Default1
limit?number

Items per page

Range1 <= value <= 100
Default20
sortBy?string

Sort by field

Value in

  • "nameHe"
  • "nameEn"
  • "expenseCount"
  • "totalExpenseAmount"
  • "lastExpenseDate"
  • "createdAt"
sortOrder?string

Sort direction

Default"ASC"

Value in

  • "ASC"
  • "DESC"

Response Body

application/json

curl -X GET "https://example.com/suppliers"
{  "items": [    {      "id": "string",      "businessId": "string",      "nameHe": "string",      "nameEn": "string",      "businessNumber": "string",      "vatNumber": "string",      "email": "string",      "phone": "string",      "address": "string",      "city": "string",      "website": "string",      "contactPerson": "string",      "defaultCategoryId": "string",      "vatRecognitionRate": 0,      "incomeTaxRecognitionRate": 0,      "defaultCurrency": "string",      "paymentTermsDays": 0,      "isActive": true,      "isFavorite": true,      "expenseCount": 0,      "totalExpenseAmount": 0,      "lastExpenseDate": "2019-08-24T14:15:22Z",      "source": "manual",      "metadata": {},      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0}