---
title: "🔒 List contact persons V3"
method: GET
path: "/api/v3/customers/{customerId}/contactPersons"
tags: ["Customer"]
---

# 🔒 List contact persons V3

`GET /api/v3/customers/{customerId}/contactPersons`

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`.

Paginated list of contact persons.

## Path parameters

- `customerId` string, required

## Query parameters

- `filter` object[]
  - `key` 'id' | 'name' | 'country' | 'city' | 'zipCode'
  - `op` 'equals' | 'notEquals' | 'in' | 'notIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' — operator
  - `value` union — The property value.
    - string
    - string[]
- `sort` string[]
- `include` string[]
- `perPage` integer
- `page` integer

## Response `200`

Paginated list of contact persons.

- object
  - `data` object[]
    - `id` string — ID of contact person
    - `type` 'mrs' | 'mr' | 'company' | 'other' — Type of contact person
    - `name` string — Name of contact person
    - `title` string — Title of contact person
    - `salutation` string — Salutation of contact person
    - `department` string — Department of contact person
    - `subDepartment` string — Sub-Department of contact person
    - `street` string — Street of contact person address
    - `addressSupplement` string — Address supplement of contact person address
    - `zipCode` string — Zip code of contact person address
    - `city` string — City of contact person address
    - `country` string — Country of contact person address
    - `state` string — State of contact person address
    - `phone` string — Phone number of contact person
    - `mobile` string — Mobile number of contact person
    - `fax` string — Fax number of contact person
    - `email` string — Email address of contact person
    - `contactPersonDetails` object — Contact person details
      - `position` string
      - `birthday` string, date
      - `language` string
      - `allowMarketingEmails` boolean
      - `internalNote` string
      - `remarks` string
    - `groups` object[] — Group information
      - `id` string — ID of group
    - `createdAt` string, date-time — Creation timestamp
    - `updatedAt` string, date-time — Last update timestamp
  - `meta` object — Pagination meta data
    - `currentPage` integer — The current page number
    - `from` integer, nullable — The first item being returned in the current page
    - `path` string — The base path for the paginated results
    - `perPage` integer — The number of items shown per page
    - `to` integer, nullable — The last item being returned in the current page
  - `links` object — Pagination links
    - `first` string, nullable — URL to the first page
    - `last` string, nullable — URL to the last page
    - `prev` string, nullable — URL to the previous page
    - `next` string, nullable — URL to the next page

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests

---

[API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/versions/8a27ba392442/schema)