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

# List customers across locations

`GET /v1/customers`

## Request

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

Lists the persons, companies and vehicles of every location this API key can be used on, as short entries, one page at a time. The call works only when sharing customers between locations is turned on for the organisation in Cliento. Otherwise it is refused with `not_allowed`, and you list customers per location instead. Each entry has the `locationId` it is registered at. Read the full record, change it or delete it under that location, in Persons, Companies or Vehicles. The filters work as on a location's list.

## Query parameters

- `email` string
- `phoneNumber` string
- `externalReference` string
- `number` string
- `type` 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)