v1
latestOpenAPI 3.1.02026-07-22155403592.5 KBProperty Management System
Customers
Get customers (PMS)
Returns a list of all the customers
get/consumers/{consumer_id}/pms/customers
Path parameters
consumer_idstring uuid required
Query parameters
pageinteger
Page number
sizeinteger
Page size
searchstring nullable
Filter based on other parameters than the email/phone, e.g. firstname, lastname
emailstring nullable
Filter based on email of customer
phonestring nullable
Filter based on phone of customer
Response
Successful Response
Example response
{
"items": [
{
"first_name": "John",
"last_name": "Doe",
"company_name": "Acme Corp",
"phone": "+1234567890",
"email": "john.doe@example.com",
"account_number": "701000",
"created_on": "2023-09-25T12:00:00",
"addresses": [
{
"address_type": "home",
"name": "Home",
"street": "Main Street",
"number": "123",
"box": "A",
"city": "Paris",
"postal_code": "75000",
"country": "FR"
}
]
}
]
}