v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

Customer

🔒 View contact person V3

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: customer:read.

View a single contact person.

get/api/v3/customers/{customerId}/contactPersons/{contactPersonId}

Path parameters

customerIdstring required

contactPersonIdstring required

Query parameters

includestring[]

Response

View a single contact person.

Example response

{
  "data": {
    "id": "17",
    "type": "mr",
    "name": "Alice Smith",
    "title": "Ms.",
    "salutation": "Dear Alice,",
    "department": "Sales",
    "subDepartment": "Customer Service",
    "street": "123 Main St",
    "addressSupplement": "Suite 100",
    "zipCode": "12345",
    "city": "Springfield",
    "country": "US",
    "state": "CA",
    "phone": "+1-234-567-8900",
    "mobile": "+1-800-567-8900",
    "fax": "+1-234-567-8901",
    "email": "alice@example.com",
    "contactPersonDetails": {
      "position": "Head of Controlling",
      "birthday": "1978-04-12",
      "language": "DE",
      "allowMarketingEmails": false,
      "internalNote": "Key decision‑maker for raw‑material contracts; prefers email after 17:00 CET.",
      "remarks": "Speaks fluent English, French and Mandarin. Holds a PhD in Economics."
    },
    "groups": [
      {
        "id": "1"
      }
    ],
    "createdAt": "2025-03-15T09:27:00+01:00",
    "updatedAt": "2025-10-20T14:45:12+01:00"
  }
}