Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Customer - Contact Person

List contact persons

Provides a list of contact persons belongs to a customer related to given filters

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

Path parameters

customerIdstring required

Resource identifier.

Example:17

The customer's identifier.

Query parameters

key'type' | 'name' | 'title' | 'birthday' | 'birthdayShowInCalendar' | 'sendBirthdayCard' | 'marketingBan' | 'department' | 'subDepartment' | 'position' | 'street' | 'additionalStreet' | 'zip' | 'city' | 'state' | 'country' | 'phone' | 'fax' | 'mobile' | 'salutation' | 'email' | 'group'
op'equals' | 'notEquals' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'lessThan' | 'greaterThan' | 'in' | 'notIn'
valuestring
numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

field'id' | 'name' | 'customerId' | 'type' | 'title' | 'birthday' | 'birthdayShowInCalendar' | 'sendBirthdayCard' | 'marketingBan' | 'department' | 'subDepartment' | 'position' | 'street' | 'additionalStreet' | 'zip' | 'city' | 'state' | 'country' | 'phone' | 'fax' | 'mobile' | 'salutation' | 'email' | 'others' | 'comment'
dir'asc' | 'desc'

Response

List of contact persons

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"
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  },
  "links": {
    "self": "http://localhost/api/customers/123/contactPerson?page[number]=1&page[size]=10",
    "next": "http://localhost/api/customers/123/contactPerson?page[number]=2&page[size]=10",
    "prev": null,
    "customer": "/api/v2/customers/123"
  }
}