customer-controller
Get customers by Customer Ids (getCustomersByIds)
Returns a list of Customer objects based on the provided ids.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
get/api/customers
Query parameters
pageSizeinteger required
Maximum amount of entities in a one page
pageinteger required
Sequence number of page starting from 0
textSearchstring
The case insensitive 'substring' filter based on the customer title.
sortProperty'createdTime' | 'title' | 'email' | 'country' | 'city'
Property of entity to sort by
sortOrder'ASC' | 'DESC'
Sort order. ASC (ASCENDING) or DESC (DESCENDING)
customerIdsstring[] required
A list of customer ids, separated by comma ','
Response
OK
Example response
[
{
"id": {
"id": "784f394c-42b6-435a-983c-b7beff2784f9",
"entityType": "CUSTOMER"
},
"createdTime": 1609459200000,
"country": "US",
"state": "NY",
"city": "New York",
"phone": "+1(415)777-7777",
"email": "example@company.com",
"title": "Company A",
"tenantId": {
"id": "784f394c-42b6-435a-983c-b7beff2784f9",
"entityType": "TENANT"
},
"name": "Company A",
"additionalInfo": {}
}
]