iotoms Docs

List customers

GET
/api/v1/crm/customers

Returns a paginated list of customers (0-based page, default size 20). Filter by contact details, first name, status, category, country code, or created/updated date-times (ISO 8601). With no filters all customers are returned; with any filter only ACTIVE customers are returned unless status is given. To sync recent changes use updatedFrom.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

mobileNumber?string

Exact mobile number to match.

landPhoneNumber?string

Exact landline number to match.

firstName?string

Return customers whose first name contains this text, ignoring case.

status?array<string>

One or more statuses: ACTIVE, INACTIVE, ARCHIVED, DELETED. Repeat the parameter for several; unknown values are ignored. Defaults to ACTIVE when any filter is used.

email?string

Return customers whose email contains this text, ignoring case.

customerNumber?string

Accepted but not currently applied as a filter. To fetch one customer by number, use Get a customer.

category?string

Exact merchant-defined customer category, e.g. Wholesale.

updatedSince?string

ISO 8601 date-time, e.g. 2026-10-01T00:00:00Z. Accepted but not currently applied; use updatedFrom to get recently changed customers.

createdOn?string

ISO 8601 date-time; matches customers created at exactly this instant.

createdFrom?string

ISO 8601 date-time; only customers created at or after this time.

createdTo?string

ISO 8601 date-time; only customers created at or before this time.

updatedFrom?string

ISO 8601 date-time; only customers last changed at or after this time. Use it to sync recent changes.

updatedTo?string

ISO 8601 date-time; only customers last changed at or before this time.

countryCode?string

Exact dialling or country code stored on the customer, e.g. +971.

page?integer

Page number, starting at 0. See Paging.

Formatint32
Default0
size?integer

Number of records per page.

Formatint32
Default20

Response Body

OK

*/*
  1. response
content?array<>|

The records on this page.

page?

Paging details: page size, current page number, total matching records and total pages.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/crm/customers'
Example Response
{  "content": [    {}  ],  "page": {    "size": 0,    "number": 0,    "totalElements": 0,    "totalPages": 0  }}