---
title: "Find vendors based on search parameters."
method: POST
path: "/api/vendors/list"
tags: ["Vendor"]
---

# Find vendors based on search parameters.

`POST /api/vendors/list`

## Query parameters

- `Sort.Field` string
- `Sort.Dir` 'ascending' | 'descending' — Specify sorting direction.
- `Skip` integer
- `Take` integer

## Request body

- VendorRequestFindParameters — Parameters used for searching/finding vendors.
  - `name` string, nullable — Filter to vendors who's name contains the given string
  - `vendorCode` string, nullable — Unique identifier for this vendor.
  - `externalReference` CommonExternalReferenceFindDto — Search parameter for identifier record(s) via their external identifiers.
    - `key` string, required — Specifies the group name (key) that this external reference originates from (e.g. an external application name)
    - `type` string, nullable — Arbitrary sub-key that can be used to qualify the value
    - `externalId` string, nullable — The external identifier

## Response `200`

List of vendors matching the filters

- DtoVendorDtoWithDetails[]
  - `id` string, required — Id
  - `name` string, required — The name to give the vendor. Must be unique to all active vendors.
  - `vendorCode` string, nullable — Unique identifier for this vendor.
  - `paymentTermsId` string, nullable — Payment terms identifier. Please reference /api/payment-terms endpoint.
  - `paymentTerms` CommonReferenceDto — Represents a reference to a document in a DB collection
    - `id` string, nullable — Unique Id associated to the referenced object
    - `name` string, nullable — Descriptive name associated to the object
  - `notes` string, nullable — General notes associated to this vendor
  - `externalReferences` object, nullable — External references associated with this entity.
  - `customFields` object, nullable — Custom fields that have been defined on this entity.
  - `currencyCode` string, nullable — The currency of the vendor.
  - `status` string, nullable — Approval/quality status of the vendor. One of: Approved, Probation, Monitor, Disqualified, Other.
  - `active` boolean — Whether the vendor is active.
  - `leadTime` integer, nullable — Default lead time in days.
  - `url` string, uri, nullable — Vendor website URL.
  - `vendorSince` string, date-time, nullable — Date the vendor relationship began.
  - `addresses` VendorAddressDto[] — The addresses associated with the vendor
    - `name` string, nullable — Name of the address (Bob's Shipping, Primary, Reno Warehouse, etc).
    - `address1` string, required — Primary address line.
    - `address2` string, nullable — Second address line.
    - `address3` string, nullable — Third address line.
    - `city` string, required — Address city
    - `stateProvince` string, nullable — Address state/province.
    - `postalCode` string, required — Postal/zip code.
    - `country` string, nullable — Country identifier.
    - `shippingLeadTime` integer, nullable — Lead time for shipping contents.
    - `primaryBilling` boolean — Signifies if this is a primary billing address.
    - `primaryShipping` boolean — Signifies if this is a primary billing address.
    - `id` string, required — Unique id associated to this entity.
    - `email` string, email, nullable — Email address
    - `phone` string, nullable — Associated phone number
    - `fax` string, nullable — Associated fax number
    - `notes` string, nullable — General notes associated to this vendor address

---

[API](https://skmtc.net/fulcrumpro/apis/fulcrum-publicapi.md) · [All operations](https://skmtc.net/fulcrumpro/apis/fulcrum-publicapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fulcrumpro/fulcrum-publicapi/versions/1b5649cff14a/schema)