---
title: "List customers of every type"
method: GET
path: "/v1/locations/{locationId}/customers"
tags: ["Customers"]
---

# List customers of every type

`GET /v1/locations/{locationId}/customers`

## Request

- Base URL: `https://api.cliento.com`
- URL: `https://api.cliento.com/v1/locations/{locationId}/customers`
- Auth: HTTP bearer

The location's persons, companies and vehicles in one list of short entries, oldest first. Use it to find something when you do not know its type, for example from a phone number; then read it in full from Persons, Companies or Vehicles, as the id's prefix and `type` say.

## Path parameters

- `locationId` string, required

## Query parameters

- `type` string[]
- `email` string
- `phoneNumber` string
- `number` string
- `externalReference` string
- `limit` integer
- `after` string

## Response `200`

OK

- CustomerList
  - `data` Customer[], required
    - `id` string, required
    - `locationId` string, required
    - `name` string
    - `number` string: The number that identifies it, when it has one: a person's identity number, a company's organisation number or a vehicle's registration number.
    - `type` string, required: `person`, `company` or `vehicle`. It also says where to read the rest: Persons, Companies or Vehicles. More values may be added.
  - `nextCursor` string: Pass as `after` to fetch the next page. Absent on the last page.

## Other responses

- `default`: Any failure. See the Errors section.

---

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