Client
Retrieve a batch of clients
Get a batch of clients for the specified client ids
get/api/business/{businessId}/client-batch
Path parameters
businessIdstring required
Query parameters
client_idstring[] required
list of client ids
Response
Batch of clients retrieved
Example response
{
"_embedded": {
"clients": [
{
"linkedClientMobile": "871229345",
"landLine": "35312345667",
"email": "test@phorest.com",
"birthDate": "2024-11-01",
"clientSince": "2024-11-01T09:00:00Z",
"notes": "sample",
"preferredStaffId": "SE-J0emUgQnya14mOGdQS",
"externalId": "123456789",
"creatingBranchId": "SE-J0emUgQnya14mOGdQS",
"clientCategoryIds": [
"hAhxpPMKsDWX59Ir-LX_WQ",
"Yj9wkv0RRVrfgX7YNvhEQw"
],
"clientId": "ab123",
"version": 1,
"firstName": "John",
"lastName": "Doe",
"mobile": "871229345",
"createdAt": "2024-11-01T09:00:00Z",
"updatedAt": "2024-11-01T09:00:00Z",
"photoUrl": "https://some-picture.com/photo.jpg",
"creditAccount": {
"outstandingBalance": 123.12,
"creditDays": 5,
"creditLimit": 502.32
},
"loyaltyCard": {
"serial": "1424242",
"points": 100
},
"mergedToClientId": "ab123",
"linkedClientId": "ab123",
"firstVisit": "2024-11-01",
"lastVisit": "2024-11-01",
"lastVisitedBranchId": "ab123"
}
]
}
}