API Reference
  1. WSHOP API
  2. Contacts

Retrieve contacts (newsletter subscribers)

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

Returns prospects of a site (newsletter records not linked to a customer account). Default 1000 records per page, max 2000.

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
required

Site ID (CUS0059 if missing, CUS0060 if unknown)

integer
≥ 0

Contact (newsletter) ID. Must be a JSON integer (CUS0020 otherwise).

string
length ≤ 100

Exact email. CUS0062 if it belongs to a customer, CUS0023 if unknown.

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)

integer
≥ 1

Page number (1-based)

integer
≤ 2000

Records per page (default 1000, max 2000)

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?