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

# List clients

`GET /clients`

## Request

- Base URL: `https://api.lumabill.ch/v1`
- URL: `https://api.lumabill.ch/v1/clients`
- Auth: HTTP bearer

## Query parameters

- `page` integer
- `per_page` integer
- `q` string

## Response `200`

A paginated list of clients

- object
  - `data` Client[], required
    - `id` string, uuid, required
    - `name` string, required
    - `email` string, email, nullable
    - `phone` string, nullable
    - `address` string, nullable
    - `address_line2` string, nullable
    - `city` string, nullable
    - `zip` string, nullable
    - `country` string, nullable: ISO 3166-1 alpha-2 country code
    - `company_name` string, nullable
    - `vat_number` string, nullable
    - `created_at` string, date-time, required
  - `meta` PaginationMeta, required
    - `page` integer, required
    - `per_page` integer, required
    - `total` integer, required: Total number of items across all pages

## Other responses

- `401`: Invalid or missing API key
- `403`: Subscription required or read-only key on a write endpoint
- `429`: Rate limit exceeded
- `500`: Internal server error

---

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