iotoms Docs

List new customers

GET
/api/v1/reports/customer/new

Returns customers who registered between from and to (both default to today, YYYY-MM-DD), oldest registration first, with the date and amount of their first sale in that range.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

from?string

Start date (YYYY-MM-DD), defaults to today

Formatdate
to?string

End date (YYYY-MM-DD), defaults to today

Formatdate

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

Response Body

OK

*/*
  1. response
status*string

Outcome of the request: SUCCESS when it worked; errors return an error status with the reason in message.

message*string

Short human-readable message describing the outcome.

data?array<>|

Customers registered in the date range, oldest registration first.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/customer/new' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "customerNumber": "string",      "customerName": "string",      "acquisitionDate": "2019-08-24",      "firstOrderDate": "2019-08-24",      "firstOrderAmount": 0    }  ]}