---
title: "List contacts"
method: GET
path: "/contacts"
tags: ["contacts"]
---

# List contacts

`GET /contacts`

## Request

- Base URL: `https://productlane.com/api/v1`
- URL: `https://productlane.com/api/v1/contacts`
- Auth: HTTP bearer

List all contacts for your workspace. Filter by email (partial match) or companyId. Authentication is required.

## Query parameters

- `skip` integer
- `take` integer
- `email` string
- `companyId` string

## Response `200`

Successful response

- object
  - `contacts` object[], required
    - `id` string, required
    - `email` string, required
    - `name` string, nullable, required
    - `imageUrl` string, nullable, required
    - `companyId` string, nullable, required
    - `workspaceId` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `isDeleted` boolean, required
    - `version` number, required
    - `intercomId` string, nullable
    - `hubspotId` string, nullable
    - `productboardId` string, nullable
    - `zendeskId` string, nullable
    - `company` object, nullable, required
      - `id` string, required
      - `name` string, required
      - `workspaceId` string, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `isDeleted` boolean, required
      - `version` number, required
      - `linearCustomerId` string, nullable, required
      - `size` number, nullable, required
      - `revenue` number, nullable, required
      - `statusId` string, nullable, required
      - `statusName` string, nullable, required
      - `statusColor` string, nullable, required
      - `tierId` string, nullable, required
      - `tierName` string, nullable, required
      - `logoUrl` string, nullable, required
      - `domains` string[], required
      - `autoAdd` boolean, nullable, required
      - `intercomId` string, nullable, required
      - `hubspotId` string, nullable, required
      - `productboardId` string, nullable, required
      - `externalIds` string[], required
      - `slugId` string, nullable, required
  - `nextPage` object, nullable, required
    - `take` number, required
    - `skip` number, required
  - `hasMore` boolean, required
  - `count` number, required

## Other responses

- `default`: Error response

---

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