v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

Customer - Contact Person

View contact person

Gets a single contact person of given customer by ID.

get/api/v1/customers/{customerId}/contactPerson/{contactPersonId}

Path parameters

customerIdstring required

Resource identifier.

Example:17

The customer's identifier.

contactPersonIdstring required

Resource identifier.

Example:17

The contact person's identifier.

Response

Contact person object

Example response

{
  "data": {
    "id": "12345",
    "type": "mrs",
    "name": "Kathleen Minority",
    "title": "Prof. Dr. Dr.",
    "birthday": "2001-02-02",
    "birthdayShowInCalendar": false,
    "sendBirthdayCard": true,
    "marketingBan": false,
    "department": "Finance",
    "subDepartment": "Controlling",
    "position": "Head of Controlling",
    "address": {
      "street": "11W 53rd St",
      "additionalStreet": "6. Floor",
      "zip": "10019",
      "city": "New York",
      "state": "NY",
      "country": "US"
    },
    "contact": {
      "phone": "+1 917 55512345",
      "fax": "+1 917 55512345-1",
      "mobile": "+1 800 55554321",
      "salutation": "Dear Mrs. Minority, my most value customer",
      "email": "k.m@ny.tld"
    },
    "groups": [
      "1",
      "23",
      "34"
    ],
    "comment": "This is a internal comment for employees eyes only",
    "others": "some other things necessary to write down belong to this contact ...",
    "createdAt": "2025-09-16 15:55:09",
    "updatedAt": "2025-09-16 15:55:09",
    "language": "DE"
  },
  "links": {
    "self": "http://localhost/api/customers/123/contactPerson/456",
    "customer": "http://localhost/api/v2/customers/123"
  }
}