List vendors

Operation ID: vendors

Group: Accounting › Vendors

Open in the interactive reference

GET /accounting/vendors

Read-only: Reads and returns; changes nothing.

Lists vendors. To filter by name, contact email, or legal entity, use POST accounting/vendors/search.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.

Query surface

Response

200 Success

Under data, an array of vendorsRow:

Field Type Required Filter Sort Description
id string no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The unique identifier for the vendor.
vendorName string | null no no no The legal or trading name of the vendor.
vendorNumber string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The vendor number, for example 'V-2041'. Absent until one has been assigned.
vendorType string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The kind of vendor. Possible values: 'supplier', 'contractor', 'tax', 'benefits', 'payrollProvider', 'healthInsurance'.
vendorSubType string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes A finer classification within the vendor type. Possible values: 'direct', 'indirect'.
status string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The lifecycle status of the vendor. Possible values: 'active', 'inactive'. An inactive vendor stays readable so historical documents still resolve, and is not offered for new ones.
paymentTerms string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The default payment-terms key applied to this vendor's bills, for example 'net30' or 'dueOnReceipt'. Stored as supplied.
preferredCurrency string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The currency the vendor prefers to be paid in. Format ISO 4217, for example 'USD'.
independentContractor string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) no Whether the vendor is an independent contractor. Possible values: 'yes', 'no', 'unsure'.
externalVendorId string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) no The identifier this vendor has in an external system. It is not unique.
origin string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) no The source system that created the vendor, for example 'app'.
mainContactEmail string | null no no no The email address of the vendor's main contact.
mainContactName string | null no no no The name of the vendor's main contact.
lastModifiedDate date-time | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The date and time the vendor last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. 
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "vendorName": "<vendorName>",
      "vendorNumber": "<vendorNumber>",
      "vendorType": "<vendorType>",
      "vendorSubType": "<vendorSubType>",
      "status": "<status>",
      "paymentTerms": "<paymentTerms>",
      "preferredCurrency": "<preferredCurrency>",
      "independentContractor": "<independentContractor>",
      "externalVendorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "origin": "<origin>",
      "mainContactEmail": "<mainContactEmail>",
      "mainContactName": "<mainContactName>",
      "lastModifiedDate": "2026-01-15T09:30:00.000Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<nextCursor>"
  }
}

Statuses