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

# List customers

`GET /v2/customers`

## Request

- Base URL: `https://api.slash.com`
- URL: `https://api.slash.com/v2/customers`
- Auth: API key in header `X-API-Key`

List the customers you invoice. See [Customers](/docs/v2/invoices/overview#customers).

## Query parameters

- `cursor` string
- `limit` integer
- `sort` 'createdAt' | 'name'
- `sortDirection` 'asc' | 'desc'
- `status` 'active' | 'archived'
- `search` string

## Response `200`

A page of customers.

- object
  - `items` Customer[], required
    - `id` string, required: Customer id with the `le_cus_` prefix.
    - `name` string, required: The name invoices are addressed to.
    - `email` string, required: Where invoices and reminders are sent.
    - `phone` string
    - `address` Address
      - `line1` string, required
      - `line2` string
      - `city` string, required
      - `state` string
      - `postalCode` string
      - `countryCode` string: ISO 3166-1 alpha-2 country code.
    - `status` 'active' | 'archived', required: `archived` marks a customer you no longer bill. Archived customers can still be invoiced and are listed unless you filter by `status`.
    - `createdAt` string, date-time, required
  - `metadata` PaginationMetadata, required
    - `nextCursor` string: Opaque cursor for the next page. Omitted on the final page.
    - `count` integer, required: Number of items in this page.

## Other responses

- `400`: - `invalid_request (request shape)` — The body, query, or headers failed validation, or a required header is missing. `details` has one entry per failing location, keyed by JSON pointer or header name.
- `401`: - `unauthorized` — API key authentication is missing or invalid.
- `403`: - `forbidden (legal entity)` — The credential is not permitted to act for the selected legal entity. - `not_available` — Public API v2 is not yet available. Use [Public API v1](https://docs.slash.com/introduction) in the meantime. - `user_api_key_required` — The API key is scoped to a legal entity rather than a user. Every v2 request needs a user API key, created under Settings → API keys in the Slash dashboard, together with the `x-legal-entity` header.
- `404`: - `not_found` — No resource matches the identifier. When the identifier is a field of the request, `details` names that `field` and the `id` it received.
- `429`: The request exceeded the applicable rate limit. The response body is plain text, not the error object; clients must not depend on its wording.
- `500`: - `internal` — Slash could not complete the request. Quote `referenceId` when contacting Slash support.

## Changes

- **2026-10-16** `8b5d371ffeea`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/slashfi/apis/slash-public-api/changes/v2/customers/get.md)

---

[API](https://skmtc.dev/slashfi/apis/slash-public-api.md) - [All operations](https://skmtc.dev/slashfi/apis/slash-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/slashfi/apis/slash-public-api/revisions/eaed2d63c9e2?raw)