API Reference
  1. WSHOP API
  2. Customers

Retrieve customers

post
https://{instance}.wshop.cloud/api/v1/customer/get

Returns customers (registered and guests) and prospects (newsletter contacts not linked to a customer account) of all sites, or of site.

Pagination: limit is split evenly between customers and prospects (default: 1000 + 1000, max 1000 + 1000). page is the page number (1-based).

Business errors are returned with HTTP 200 as {"success": false, "error": {"message": "CUS…"}}.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
≥ 0

Customer ID. Must be a JSON integer (CUS0020 otherwise).

string
length ≤ 100

Exact email (customer or prospect). Unknown email: CUS0023; invalid email: CUS0024.

string

Last update date, lower bound. Only applied together with end. Format (YYYY-MM-DD HH:II:SS)

string

Last update date, upper bound. Only applied together with begin. Format (YYYY-MM-DD HH:II:SS)

string

Creation date, lower bound. Only applied together with created_to. Format (YYYY-MM-DD HH:II:SS)

string

Creation date, upper bound. Only applied together with created_from. Format (YYYY-MM-DD HH:II:SS)

integer

Filter by site ID (CUS0060 if unknown)

integer
≥ 1

Page number (1-based)

integer
≤ 2000

Total number of records per page, split evenly between customers and prospects (max 2000). Default: 1000 customers + 1000 prospects.

Responses

Updated 6 months ago

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

Updated 6 months ago

Did this page help you?