---
title: "List Customer Contacts"
method: GET
path: "/customers/{customer_id}/contacts"
tags: ["Contacts"]
---

# List Customer Contacts

`GET /customers/{customer_id}/contacts`

## Request

- Base URL: `https://api.upflow.io/v1`
- URL: `https://api.upflow.io/v1/customers/{customer_id}/contacts`
- Auth: API key in header `X-Api-Key` and API key in header `X-Api-Secret`

List contacts for a specific customer.

## Query parameters

- `offset` integer
- `page` integer
- `limit` integer

## Response `200`

Paginated list of customer contacts.

- object
  - `offset` integer: 0-based index of the first item returned. Returned when using offset-based pagination or by default.
  - `page` integer: Page number (1-based). Returned when using page-based pagination.
  - `limit` integer, required: Maximum number of items returned.
  - `total` integer, required: Total items in the set.
  - `contacts` Contact[], required
    - `firstName` string: Contact first name.
    - `lastName` string: Contact last name.
    - `phone` string: Contact phone number.
    - `email` string, email, required: Contact email (must be unique).
    - `position` string: Contact position label.
    - `externalId` string: Contact custom external identifier.
    - `isMain` boolean: Indicates if this is the main contact for the customer.
    - `customFields` CustomFieldValueAttribs[]: List of contact's custom fields values.
      - `id` string, uuid, nullable: The Custom Field ID.
      - `externalId` string, nullable: Custom field external identifier.
      - `value` union: The value of the custom field. Can be a primitive (string, integer, boolean), a single object for SELECT types, an array of objects for MULTI_SELECT types.
        - integer: Integer value.
        - string: String value (could also be date-time or date).
        - boolean: Boolean value.
        - CustomFieldValueOption
          - `externalId` string, nullable: External identifier for the option.
          - `label` string, required: Display label for the option.
        - CustomFieldValueOption[]: Value for MULTI_SELECT type.
          - `externalId` string, nullable: External identifier for the option.
          - `label` string, required: Display label for the option.
    - `id` string, uuid, required: The contact ID.
    - `positionId` string, uuid, nullable: The custom contact position ID.
    - `createdAt` string, date-time: The date at which the contact was created (ISO 8601 format).

---

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