List customers

List customers with their contact details, optionally filtered by available attributes. Deleted customers are left out unless the request filters by customer_id or by code.

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

Database ID of the customer. One value or a list, for example ?customer_id=5 or ?customer_id[]=5&customer_id[]=6. Deleted customers are returned when this filter is given.

string | null

A unique number to identify the customer. Partial match. Includes matching deleted customers when a non-empty code is supplied.

string | null

Name of the customer. Partial match.

string | null

Registration number of customer's company. Partial match.

string | null

Tax/VAT number of customer's company. Partial match.

Status of customer. Statuses are configured in MRPeasy -> Settings -> System settings -> Customer statuses. One value or a list, for example ?status=10 or ?status[]=10&status[]=20.

integer | null

Sales person who handles that customer.

integer | null

Minimum creation date and time as UNIX timestamp.

integer | null

Maximum creation date and time as UNIX timestamp. The whole of that day is covered.

integer | null

Minimum next-contact date and time as UNIX timestamp.

integer | null

Maximum next-contact date and time as UNIX timestamp. The whole of that day is covered. A customer without a next-contact date never matches.

string | null

Phone number in contact details. Partial match.

string | null

Email address in contact details. Partial match.

string | null

Website URL in contact details. Partial match.

string | null

Teams ID in contact details. Partial match. Named skype in REST API v1.

string | null

Address in contact details. Partial match. An exact country name or two- or three-letter ISO code also matches structured addresses.

string | null

Shipping address in contact details. Partial match. An exact country name or two- or three-letter ISO code also matches structured addresses.

custom_values
array of objects | null

Conditions on custom fields of the customer. All of them must hold. Example for a text field: ?custom_values[0][field_id]=1&custom_values[0][value]=abc. Replace 1 with your custom field ID; use indices 0, 1, etc. for separate conditions.

custom_values
integer

Maximum number of records to return (1–1000).

integer

Number of records to skip for pagination.

Responses

401

Unauthorized

413

Content Too Large - please use smaller ´limit´

429

Too many requests

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json