Skip to main content

ClientListItemDto

idnumberrequired

Unique identifier for the client

namestringrequired

Name of the client/company

Possible values: >= 2 characters

Example: Acme Corporation
emailstring<email>

Email address of the client

Example: contact@acme.com
citystring

City where the client is located

Example: New York
phonestring

Phone number of the client

Example: +1-555-0123
addressstring

Street address of the client

Example: 123 Business Street
postalCodestring

Postal code of the client

Example: 10001
customerIdstring

Custom customer ID assigned by the workspace

Example: CUST-001
countrystring

Country where the client is located

Example: United States
languagestring

Primary language of the client

Example: en
privatebooleanrequired

Whether the client is private or business

Example: false
contactPersons 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 Smith
    emailstringrequired

    Email address of the contact person

    Example: jane.smith@acme.com
  • ]
  • ClientListItemDto
    {
    "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"
    }
    ]
    }