GuidesAPI Reference
Log In
API Reference
These docs are for v2025.2.0. Click to read the latest docs for v2026.2.0.

List customers

get
https://api.epicorretailcloud.com/api/sales/v1/customer/

Returns a paginated list of customers.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uri
length ≥ 1

This URL will be invoked when results are ready for retrieval. The payload will contain the location of the results file. Use the Check Deferred Execution Status API to poll for status, or include a value for callback_url to be notified when results are ready.

date-time

Filter upon the create date/time using ISO8601 format. Assumption is UTC unless TZ offset is specified.

string
^-?\d{0,9}(?:\.\d{0,4})?$

Filter upon a customer's amount of available credit.

boolean

Indicates if this customer is currently on credit hold.

integer
-2147483648 to 2147483647

The unique system assigned value that identifies this record.

string
length ≥ 1

The alternate customer number.

boolean

Filter upon active/inactive customers.

boolean

Set to true to request asynchronous processing, which is required for larger data requests.

integer

Maximum number of results per page. The default is 25.

integer

Specify the loyalty program id upon which to filter.

integer
enum

Filter upon the value of the customer loyalty status indicator.

  • 1 - Pending
  • 10 - Active
  • 20 - Canceled
  • 30 - Expired
  • 40 - Need Customer Information
  • 50 - Inactive
Allowed:
string

Fields to order upon. Valid fields include: customer_id, customer_number, name

integer

Page of results to retrieve

string
^-?\d{0,9}(?:\.\d{0,4})?$

Filter upon a customer's running balance.

string

Term(s) to search for. The following fields will be searched: email, name, first_name, last_name, phone_number, is_tax_exempt, alt_customer_number

date-time

Filter upon the update date/time using ISO8601 format. Assumption is UTC unless TZ offset is specified.

Headers
integer
required

The id of the active store to be used for this API invocation

Responses

Updated over 1 year ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago

Did this page help you?