List customers

get

https://api.mrpeasy.com/rest/v1/customers

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

customer_id

integer

Database ID of the customer.

code

string

A unique number to identify the customer.

title

string

Name of the customer.

reg_nr

string

Registration number of customer's company.

tax_nr

string

Tax/VAT number of customer's company.

status

array of integers

Status of customer.
Statuses are configured in MRPeasy -> Settings -> System settings -> Customer statuses.

Arrays are supported, for example ?status[]=10&status[]=20.

status

user_id

integer

Sales person who handles that customer.

created_min

integer

Minimum creation date and time as unix timestamp.

created_max

integer

Maximum creation date and time as unix timestamp.

next_contact_min

integer

Minimum next-contact date and time as unix timestamp.

next_contact_max

integer

Maximum next-contact date and time as unix timestamp.

phone

string

Phone number in contact details.

string

Email address in contact details.

url

string

Website URL in contact details.

address

string

Address in contact details.

shipping_address

string

Shipping address in contact details.

skype

string

Teams/Skype ID

Headers

Range

string

Pagination range (e.g., items=0-99, items=200-249)

Responses

429

Rate limited - another request is running

200List of customers

206Partial content

400Validation failed

401Authentication failed