GetClientsResponseDto
nextCursorstring
Cursor for fetching the next page of results
Example:
eyJsYXN0SWQiOiIxMjNlNDU2NyIsImxhc3RWYWx1ZSI6IjIwMjQtMDYtMTAifQpreviousCursorstring
Cursor for fetching the previous page of results
Example:
eyJmaXJzdElkIjoiOTg3ZmVkY2IiLCJmaXJzdFZhbHVlIjoiMjAyNC0wNS0xNSJ9totalnumberrequired
Total amount of results
results object[]required
List of clients matching the query criteria
Array [
idnumberrequired
Unique identifier for the client
namestringrequired
Name of the client/company
Possible values: >= 2 characters
Example:
Acme Corporationemailstring<email>
Email address of the client
Example:
contact@acme.comcitystring
City where the client is located
Example:
New Yorkphonestring
Phone number of the client
Example:
+1-555-0123addressstring
Street address of the client
Example:
123 Business StreetpostalCodestring
Postal code of the client
Example:
10001customerIdstring
Custom customer ID assigned by the workspace
Example:
CUST-001countrystring
Country where the client is located
Example:
United Stateslanguagestring
Primary language of the client
Example:
enprivatebooleanrequired
Whether the client is private or business
Example:
falsecontactPersons object[]
Contact persons associated with the client, not available for private clients
Array [
idnumberrequired
Unique identifier for the contact person
namestringrequired
Name of the contact person
Example:
Jane Smithemailstringrequired
Email address of the contact person
Example:
jane.smith@acme.com]
]
GetClientsResponseDto
{
"nextCursor": "eyJsYXN0SWQiOiIxMjNlNDU2NyIsImxhc3RWYWx1ZSI6IjIwMjQtMDYtMTAifQ",
"previousCursor": "eyJmaXJzdElkIjoiOTg3ZmVkY2IiLCJmaXJzdFZhbHVlIjoiMjAyNC0wNS0xNSJ9",
"total": 0,
"results": [
{
"id": 0,
"name": "Acme Corporation",
"email": "contact@acme.com",
"city": "New York",
"phone": "+1-555-0123",
"address": "123 Business Street",
"postalCode": "10001",
"customerId": "CUST-001",
"country": "United States",
"language": "en",
"private": false,
"contactPersons": [
{
"id": 0,
"name": "Jane Smith",
"email": "jane.smith@acme.com"
}
]
}
]
}