API Reference

List property contacts

get
https://api.breezeway.io/public/inventory/v1/property/external-id//contacts

List property contacts configured for a Breezeway property

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the home in the PMS System

Query Params
company_id
array of int32s

Fetch property contacts associated with the specified Breezeway company IDs (cross-company access required)

company_id
int32
Defaults to 50

Records returned per page

int32

Page number for pagination

string
enum
Defaults to first_name

Attribute on the Contact to sort by

Allowed:
string
enum
Defaults to asc

Sorting order

Allowed:
Response

Updated about 1 year ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago