---
title: "List contact persons"
method: GET
path: "/api/v1/customers/{customerId}/contactPerson"
tags: ["Customer - Contact Person"]
---

# List contact persons

`GET /api/v1/customers/{customerId}/contactPerson`

## Request

- Base URL: `https://xentral.xentral.biz`
- URL: `https://xentral.xentral.biz/api/v1/customers/{customerId}/contactPerson`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/xentral/apis/xentral-api/docs/api/v1/customers/:customerId/contactPerson/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `customerId` string, required: Resource identifier.

## Query parameters

- `filter` object[]
  - `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'
  - `value` string
- `page` object
  - `number` string, required: Page number should be an integer greater than or equal to 1
  - `size` string, required: Page size should usually be an integer between 10 and 50.
- `order` object[]
  - `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 `200`

List of contact persons

- object
  - `data` object[], required
    - `id` string: Resource identifier.
    - `customer` object: The customer this contact person belongs to
      - `id` string, required: Resource identifier.
    - `type` 'company' | 'mr' | 'mrs' | 'other', nullable, required: Type of contact used later for salutations
    - `name` string, required: Full name of the contact person
    - `title` string, nullable: Additional information used for salutations
    - `birthday` string, date, nullable: Birthday of contact person in default format like 'YYYY-MM-DD
    - `birthdayShowInCalendar` boolean, nullable: Decides wether or not to show in birthday calendar
    - `sendBirthdayCard` boolean, nullable: Decides wether or not to send birthday card via serial letter module
    - `marketingBan` boolean, nullable: Decides wether or not to send serial letters to this contact
    - `department` string, nullable: Department of contact if necessary and available
    - `subDepartment` string, nullable: Sub-Department of contact if necessary and available
    - `position` string, nullable: Position or responsibility
    - `createdAt` string, date-time, required: Contact person creation date and time
    - `updatedAt` string, date-time, required: Contact person last update date and time
    - `language` string, nullable, required: Two-letter ISO 639-1 code (uppercase or lowercase allowed).
    - `address` object: Address information of the contact person
      - `street` string, nullable: Street + number of contact address
      - `additionalStreet` string, nullable: Address suffix
      - `zip` string, nullable: ZIP code of contact address
      - `city` string, nullable: City of contact address
      - `state` string, nullable: Federal state / district of contact address
      - `country` string, nullable: ISO 3166-1 (Alpha 2) Code of contact address country
    - `contact` object: Contact information of the contact person
      - `phone` string, nullable: Phone number of contact address
      - `fax` string, nullable: Fax number of contact address
      - `mobile` string, nullable: Mobile number of contact address
      - `salutation` string, nullable: Specifies dedicated salutation
      - `email` string, email, nullable: E-mail address
    - `groups` string[]: List of groups this contact person is belong to
    - `comment` string, nullable: Internal comment for this contact
    - `others` string, nullable: Every other information you deem relevant
  - `extra` object
    - `totalCount` integer, required: the total count of all items
    - `page` object, required: The pagination object containing the current page number and size
      - `number` integer, required: The current page number
      - `size` integer, required: The size of the pages
  - `links` object, required: Links related to the contact person list
    - `self` string, required: Link to the current page of contact persons
    - `next` string, nullable: Link to the next page of contact persons (null if no next page)
    - `prev` string, nullable: Link to the previous page of contact persons (null if no previous page)
    - `customer` string, required: Link to the customer resource

## Other responses

- `400`: IETF RFC 9457 Problem API compliant response
- `401`: Unable to authenticate the client
- `403`: Unable to authorize the client
- `404`: Resource was not found or not enough access privileges
- `406`: Requested resource representation does not exist.

---

[API](https://skmtc.dev/xentral/apis/xentral-api.md) - [All operations](https://skmtc.dev/xentral/apis/xentral-api/llms.txt) - [OpenAPI document](https://skmtc.dev/xentral/apis/xentral-api/revisions/ebe5ba2a4ed8?raw)