Skip to main content
GET
Page locations

Authorizations

Authorization
string
header
required

Existing Breezy API key. Grants all published reads in its associated company. No app permission scopes.

Query Parameters

limit
integer
default:50

Maximum parent records or report rows. Complete children are always included.

Required range: 1 <= x <= 100
cursor
string | null

Repeat the original filters; any valid page size may continue. Foreign-company, tampered or mismatched cursors return INVALID_CURSOR.

Minimum string length: 1
ids
string<uuid>[] | null

Repeat ids for a bounded ID set. Valid foreign or missing IDs contribute no list rows.

Required array length: 1 - 100 elements
created_from
string<date-time> | null

Inclusive creation instant.

created_before
string<date-time> | null

Exclusive creation instant.

updated_since
string<date-time> | null

Inclusive parent-record updated_at filter only; not a complete change feed.

account_id
string<uuid> | null
property_type
string | null
Minimum string length: 1

Response

Successful read. Clients ignore unrecognized response fields.

data
object[]
required
pagination
object
required
meta
object
required

Generation time and company timezone. generated_at is not a snapshot or synchronization token.