API Reference

List owner statements

get
https://open-api.guesty.com/v1/owner-statement-api/owner-statements

Returns owner statement metadata with table-parity fields (listings, business models, status, sharing channels, generation date, minimum account balance) and presigned PDF download URLs (valid for 1 hour).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 0
Defaults to 0

Offset: number of matching statements to skip before returning results. Echoed in the response skip field. Defaults to 0.

integer
1 to 100
Defaults to 25

Requested page size (1–100). Values above the max are clamped. Echoed as the effective page size in the response limit field. Defaults to 25.

string

Filter results to a specific owner by their ID

string
enum

How to interpret period filter fields.

  • When omitted and no period fields are sent: no period filter is applied; statements are returned across all periods (subject to other filters and pagination).
  • When omitted but any period field is sent (e.g. year=2025 without periodMode): the request is rejected with 400 Bad Request (periodMode is required when period fields are provided). There is no implicit mode and period fields are not ignored in that case.
  • When set: only the fields required by that mode are used; other period fields are ignored.
    Modes:
  • month — requires year + month (e.g. January 2025)
  • year — requires year (full calendar year)
  • monthRange — requires fromYear, fromMonth, toYear, toMonth (start ≤ end)
  • yearRange — requires fromYear + toYear (full years inclusive, fromYear ≤ toYear)
  • fiscalYear — requires fiscalYear (uses account fiscal start month)
  • fiscalYearRange — requires fromFiscalYear + toFiscalYear (fromFiscalYear ≤ toFiscalYear)
Allowed:
integer

Calendar year. Required for periodMode=month and periodMode=year.

integer
1 to 12

Calendar month 1–12. Required for periodMode=month.

integer

Range start year. Required for periodMode=monthRange and periodMode=yearRange.

integer
1 to 12

Range start month 1–12. Required for periodMode=monthRange.

integer

Range end year. Required for periodMode=monthRange and periodMode=yearRange.

integer
1 to 12

Range end month 1–12. Required for periodMode=monthRange.

integer

Fiscal year. Required for periodMode=fiscalYear.

integer

Fiscal range start. Required for periodMode=fiscalYearRange.

integer

Fiscal range end. Required for periodMode=fiscalYearRange.

date-time

Return statements created or updated after this ISO-8601 timestamp. Highly recommended for incremental sync.

string
enum

Filter by statement type

Allowed:
status
array of strings

Filter by lifecycle status. Repeat the query param to match any of the given values (e.g. status=APPROVED&status=PENDING).

status
sharedVia
array of strings

Filter by sharing channel. Repeat the query param to match statements shared via any given channel (e.g. sharedVia=EMAIL&sharedVia=OWNERS_PORTAL).

sharedVia
Allowed:
listingId
array of strings

Filter to statements covering the given listing ID(s). Repeat the query param for multiple listings.

listingId
businessModelId
array of strings

Filter to statements under the given business model ID(s). Repeat the query param for multiple business models.

businessModelId
date-time

Return statements with generatedAt on or after this ISO-8601 timestamp.

date-time

Return statements with generatedAt on or before this ISO-8601 timestamp.

Responses

Updated 30 days ago

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

Updated 30 days ago

Did this page help you?