BRbreezeway

List property contacts

List property contacts configured for a Breezeway property

get/property/external-id/{id}/contacts

Request

  • Base URL
    https://api.breezeway.io/public/inventory/v1
  • URL
    https://api.breezeway.io/public/inventory/v1/property/external-id/{id}/contacts
  • Auth
    API key in header Authorization

Path parameters

idstring required

ID of the home in the PMS System

Query parameters

company_idinteger[]

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

per_pageinteger

Records returned per page

pageinteger

Page number for pagination

sort_by'first_name' | 'last_name' | 'email' | 'created_at'

Attribute on the Contact to sort by

sort_order'asc' | 'desc'

Sorting order

Response

200

Changes

No recorded changes to this operation across all 1 revision of this API.