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

# List customers

`GET /customers`

## Request

- Base URL: `https://www.billingengine.com/api/v1`
- URL: `https://www.billingengine.com/api/v1/customers`
- Auth: HTTP bearer

All customers, ordered. The query parameter searches company, names and email.

## Query parameters

- `query` string
- `page` integer
- `per_page` integer

## Response `200`

A page of customers.

- object
  - `data` Customer[], required
    - `id` integer
    - `number` union
      - string
      - integer
    - `name` string: Company, or first and last name.
    - `company` string, nullable
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `email` string, nullable
    - `phone` string, nullable
    - `vat_number` string, nullable
    - `buyer_reference` string, nullable: Buyer reference (BT-10), for example a Leitweg-ID.
    - `address` Address
      - `line_1` string
      - `line_2` string, nullable
      - `postal_code` string
      - `city` string
      - `region` string, nullable
      - `country` string: ISO country code such as DE.
  - `pagination` Pagination, required
    - `page` integer, required
    - `per_page` integer, required
    - `pages` integer, required
    - `count` integer, required

## Other responses

- `400`: Malformed request: missing parameter, invalid JSON, invalid date or invalid filter.
- `401`: Missing or invalid API key.
- `403`: The API is not available in the Free plan, or the monthly invoice maximum of the plan has been reached.

---

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