---
title: "Get customers (PMS)"
method: GET
path: "/consumers/{consumer_id}/pms/customers"
tags: ["Property Management System", "Customers"]
---

# Get customers (PMS)

`GET /consumers/{consumer_id}/pms/customers`

Returns a list of all the customers

## Path parameters

- `consumer_id` string, uuid, required

## Query parameters

- `page` integer
- `size` integer
- `search` string, nullable
- `email` string, nullable
- `phone` string, nullable

## Response `200`

Successful Response

- ChiftPagePMSCustomerItem
  - `items` PMSCustomerItem[], required
    - `id` string, required — Technical id in Chift
    - `source_ref` Ref, required
      - `id` string, nullable — Technical id in the target software
      - `model` string, nullable — Name of the model/entity in the target software
    - `first_name` string, nullable — First name of the customer. In case the customer is an individual.
    - `last_name` string, nullable — Last name of the customer. In case the customer is an individual.
    - `company_name` string, nullable — Company name of the customer. In case the customer is a company.
    - `phone` string, nullable — Phone number of the customer
    - `email` string, nullable — Email address of the customer
    - `account_number` string, nullable — Number of the accounting account used (e.g. 701000)
    - `created_on` string, date-time, nullable — Creation date of the customer
    - `addresses` AddressItem[], nullable — List of addresses related to the customer
      - `address_type` string, nullable — Type of the address
      - `name` string, nullable — Name given to the address (e.g. 'home')
      - `street` string, nullable — Street name
      - `number` string, nullable — Number of the address
      - `box` string, nullable — Box of the address
      - `city` string, nullable — City name
      - `postal_code` string, nullable — Postal code of the address
      - `country` string, nullable — Country, format: ISO 3166-1 codes.
  - `total` integer, required
  - `page` integer, required
  - `size` integer, required

## Other responses

- `400` — Bad Request
- `405` — Method Not Allowed
- `422` — Validation Error
- `502` — Bad Gateway

---

[API](https://skmtc.net/chift/apis/chift-api.md) · [All operations](https://skmtc.net/chift/apis/chift-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/chift/chift-api/revisions/b5f1214a482a/schema)