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

# Find customers based on search parameters.

`POST /api/customers/list`

## Query parameters

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

## Request body

- CustomerRequestFindParameters — Parameters used for searching/finding customers.
  - `name` string, nullable — Filter to customers who's name contains the given string
  - `customerCode` string, nullable — Unique identifier for this customer.
  - `email` string, nullable — The email of the customer
  - `modifiedAfterUtc` string, date-time, nullable — Filter to customer records modified after the given datetime (in UTC)
  - `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 customers matching the filters

- CustomerDto[]
  - `id` string, required — Id
  - `name` string, required — The name to give the customer. Must be unique to all active customers.
  - `customerCode` string, nullable — Unique identifier for this customer
  - `currencyCode` string, nullable — Currency code/denomination associated to this customer. If not provided, default to the primary currency code for the organization.
  - `url` string, uri, nullable — The Customer's website
  - `creditLimit` number, double, nullable — Credit limit
  - `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
  - `salesPersonId` string, nullable — Sales person identifier. Please reference /api/users endpoint.
  - `isTaxable` boolean — Whether or not this customer is taxable on Sales Orders and Quotes
  - `taxRateIds` string[], nullable — A list of tax codes to be automatically added to new SalesOrders for the customer when AutoAddTaxLineItems process setting is enabled.
  - `externalReferences` object, nullable — External references associated with this entity.
  - `customFields` object, nullable — Custom fields that have been defined on this entity.
  - `notes` string, nullable — Notes associated to the customer.
  - `hasCustomerPortal` boolean, required — Indicates if this customer is set up to use the customer portal.
  - `customerTierId` string, nullable — Customer tier identifier. Please reference /api/customer-tiers endpoint.
  - `customerTierName` string, nullable — Customer tier name.

---

[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)