> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.fortresstech.io/api-reference/customers/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.fortresstech.io/_mcp/server.

# Customers Overview

> Overview of the Customers API endpoints and functionality

The Customers API provides endpoints for managing customer information throughout their lifecycle, from application to move-out.

## Key Concepts

### Customer Status

Customers can be in various states throughout their relationship:

* `APPLICANT` - Customer is in the application process
* `RESIDENT` - Customer is currently residing in a unit
* `PRIOR` - Former customer who has moved out

### Customer Information

Customers contain comprehensive personal and contact information:

* **Personal Details**: First name, last name, middle name, preferred name, and suffix
* **Demographics**: Birth date and gender information
* **Contact Information**: Email and phone details
* **Household Association**: Linked to specific households
* **Property Association**: Connected to specific properties

### Customer Relationships

* **Households**: Customers belong to household units
* **Work Orders**: Associated maintenance requests and service orders
* **Transactions**: Financial transaction history
* **Assets**: Associated assets and belongings
* **Attachments**: Documents and files related to the customer

## Available Endpoints

| Endpoint                                                              | Summary         | Method |
| --------------------------------------------------------------------- | --------------- | :----: |
| [`/customers`](/api-reference/customers/list-customers)               | List Customers  |   GET  |
| [`/customers/{customerId}`](/api-reference/customers/read-customer)   | Read Customer   |   GET  |
| [`/customers/{customerId}`](/api-reference/customers/update-customer) | Update Customer |   PUT  |
| [`/customers/{customerId}`](/api-reference/customers/delete-customer) | Delete Customer | DELETE |

> Overview of the Customers API endpoints and functionality


## API Docs

- Customers [List Customers](https://developer.fortresstech.io/api-reference/customers/list-customers.md)
- Customers [Read Customer](https://developer.fortresstech.io/api-reference/customers/read-customer.md)
- Customers [Update Customer](https://developer.fortresstech.io/api-reference/customers/update-customer.md)
- Customers [Delete Customer](https://developer.fortresstech.io/api-reference/customers/delete-customer.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://developer.fortresstech.io/openapi.json)
- [OpenAPI YAML](https://developer.fortresstech.io/openapi.yaml)