---
title: "Retrieves the collection of Vendor resources."
method: GET
path: "/vendors"
tags: ["Vendor"]
---

# Retrieves the collection of Vendor resources.

`GET /vendors`

Retrieves the collection of Vendor resources.

## Query parameters

- `page` integer
- `itemsPerPage` integer

## Response `200`

Vendor collection

- Vendor[]
  - `id` string — Unique identifier for this vendor note that no particular pattern in this field is guaranteed, only that this field is unique e.g: "quickbooks-726"
  - `integration` string — The key of the integration source e.g. "quickbooks", or "xero"
  - `srcId` string — The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"
  - `givenName` string, nullable — First name of the vendor e.g. "Jane"
  - `familyName` string, nullable — Last name of the vendor e.g. "Doe"
  - `companyName` string, nullable — Name of the company e.g. "Doyle-Koch LLC"
  - `displayName` string, nullable — Name displayed for vendor e.g. "Doyle-Koch"
  - `contactName` string, nullable — Name of the main contact for the vendor e.g. "John Smith"
  - `contactTitle` string, nullable — Title of the main contact for the vendor e.g. "Account Manager"
  - `accountNumber` string, nullable — Account number for the vendor e.g. "420042"
  - `phone` string, nullable — Phone number e.g. "281-381-4241"
  - `mobile` string, nullable — Mobile number e.g. "786-258-0182"
  - `fax` string, nullable — Fax number e.g. "281-381-4255"
  - `email` string, nullable — Email address for the vendor e.g. "doyle-koch@email.com"
  - `website` string, nullable — Vendor website e.g. "https://www.doylekoch.com"
  - `address` string, nullable — First line of vendor address e.g. "708 Woodland Avenue"
  - `addressLine2` string, nullable — Vendor address line 2 e.g. "Unit 105"
  - `city` string, nullable — City of the address e.g. "St Paul"
  - `state` string, nullable — Vendor state address e.g. "Alaska"
  - `country` string, nullable — Country of the address * e.g. "United States"
  - `postalCode` string, nullable — Postal code of the address * e.g. "99660"
  - `currency` string, nullable — Currency code used by vendor e.g. "USD"
  - `balance` integer, nullable — Balance in ledger for vendor in cents e.g. 650000
  - `bankAccountName` string, nullable — Bank account name associated with the vendor e.g. "Business Bank Account"
  - `bankAccountNumber` string, nullable — Bank acount number associated with the vendor e.g. "123654"
  - `notes` string, nullable — Additional note attached to vendor e.g. "Quality vendor"
  - `taxType` string, nullable — Type of tax applied to vendor e.g. "Global"
  - `isContractor` boolean, nullable — Whether the vendor is a contractor
  - `active` boolean, nullable — Whether the vendor is active
  - `created` string, date-time, nullable — Date of vendor account creation e.g. "2013-11-18T02:17:40.080Z"
  - `modified` string, date-time, nullable — Date entry was last modified e.g. "2013-11-22T02:17:40.080Z"
  - `termId` string, nullable — Reference to a Term object (payment terms) associated with this Vendor e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d"
  - `termDays` integer, nullable — The days value of the payment terms for this Vendor e.g. "15"
  - `termType` string, nullable — The type of the payment terms for this Vendor e.g. "DAYSAFTERBILLDATE"

---

[API](https://skmtc.net/bossinsights/apis/boss-insights.md) · [All operations](https://skmtc.net/bossinsights/apis/boss-insights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bossinsights/boss-insights/versions/d08a107895ad/schema)