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

# List clients

`GET /clients`

## Request

- Base URL: `https://api.heffl.com/api/v1`
- URL: `https://api.heffl.com/api/v1/clients`
- Auth: API key in header `x-api-key`

Returns a paginated list of clients. Supports search and type filtering.

## Query parameters

- `cursor` string: Cursor for pagination. Pass the previous response nextCursor value to fetch the next page.
- `limit` number: Number of items to return (max 100)
- `search` string: Search by name, email, or phone
- `type` 'company' | 'contact': Filter by client type

## Response `200`

OK

- object
  - `items` object[], required
    - `id` string, required: Client public ID
    - `number` string, required: Auto-generated client number
    - `name` string, required: Client name
    - `type` 'company' | 'contact', required: Client type
    - `firstName` string, nullable: First name (for contacts)
    - `lastName` string, nullable: Last name (for contacts)
    - `email` string, nullable: Email address
    - `phone` string, nullable: Phone number
    - `website` string, nullable: Website URL
    - `stageId` string, nullable: Client stage public ID
    - `createdAt` string, date-time, required: When the client was created
    - `customFields` object, nullable: Custom field values
  - `nextCursor` string, nullable: Cursor to fetch the next page. Null if there are no more results.
  - `hasMore` boolean, required: Whether additional results are available

---

[API](https://skmtc.dev/heffl/apis/heffl-public-api-legacy-v1.md) · [All operations](https://skmtc.dev/heffl/apis/heffl-public-api-legacy-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/heffl/apis/heffl-public-api-legacy-v1/revisions/9bdb229223a2?raw)