---
title: "List customers"
method: GET
path: "/customers"
---

# List customers

`GET /customers`

## Request

- Base URL: `https://api.instalent.io/api/v1`
- URL: `https://api.instalent.io/api/v1/customers`
- Auth: HTTP bearer

## Query parameters

- `cursor` string
- `limit` string
- `externalRef` string

## Response `200`

OK

- object
  - `data` object[]
    - `id` string, required
    - `externalRef` string, nullable, required
    - `email` string, required
    - `name` string, required
    - `status` string, required
    - `createdAt` string, required
    - `plan` object, required
      - `name` string, required
      - `status` string, nullable, required
      - `source` string, required
      - `trialEndsAt` string, nullable, required
      - `expiresAt` string, nullable, required
      - `billingHealth` string, required
      - `hasStripeSubscription` boolean, required
    - `credits` object, required
      - `total` number, required
      - `monthly` number, required
      - `rollover` number, required
      - `topUp` number, required
      - `periodEnd` string, nullable, required
    - `limits` object, required
      - `searchesMonthly` object, required
        - `used` number, required
        - `limit` number, required
      - `searchesDaily` object, required
        - `used` number, required
        - `limit` number, required
    - `keys` object, required
      - `current` object, nullable, required
        - `prefix` string, required
        - `createdAt` string, required
      - `previous` object, nullable, required
        - `prefix` string, required
        - `expiresAt` string, nullable, required
  - `nextCursor` string, nullable

## Other responses

- `4XX`: Error

---

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