Manage OwnerRez properties, bookings, guests, quotes and inquiries.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
MUTATES OwnerRez data: creates a new booking (reservation). OwnerRez API: POST /v2/bookings (JSON). A booking ties a guest to a property for a date range; the exact charge/quote shape is account-specific, so pass extra documented fields via `fields`. Returns the created booking.
The property being booked (required).
Notes on the booking.
Number of adults.
Additional documented OwnerRez fields to send in the JSON write body (merged with the typed fields above).
Arrival/check-in date (ISO-8601, e.g. 2026-08-01).
Number of children.
The guest id for the reservation.
Departure/check-out date (ISO-8601).
The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.
MUTATES OwnerRez data: creates a new booking (reservation). OwnerRez API: POST /v2/bookings (JSON). A booking ties a guest to a property for a date range; the exact charge/quote shape is account-specific, so pass extra documented fields via `fields`. Returns the created booking.
| Argument | Type | Description |
|---|---|---|
| notes | string | Notes on the booking. |
| adults | integer | Number of adults. |
| fields | object | Additional documented OwnerRez fields to send in the JSON write body (merged with the typed fields above). |
| arrival | string | Arrival/check-in date (ISO-8601, e.g. 2026-08-01). |
| children | integer | Number of children. |
| guest_id | integer | The guest id for the reservation. |
| departure | string | Departure/check-out date (ISO-8601). |
| property_id* | integer | The property being booked (required). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"property_id"
],
"properties": {
"notes": {
"type": "string",
"description": "Notes on the booking."
},
"adults": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Number of adults."
},
"fields": {
"type": "object",
"description": "Additional documented OwnerRez fields to send in the JSON write body (merged with the typed fields above).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"arrival": {
"type": "string",
"description": "Arrival/check-in date (ISO-8601, e.g. 2026-08-01)."
},
"children": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Number of children."
},
"guest_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The guest id for the reservation."
},
"departure": {
"type": "string",
"description": "Departure/check-out date (ISO-8601)."
},
"property_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The property being booked (required)."
}
}
}MUTATES OwnerRez data: creates a new guest (contact). OwnerRez API: POST /v2/guests (JSON). Emails/phones/addresses are arrays of objects — pass them via the `fields` passthrough (e.g. email_addresses:[{address:"[email protected]"}]). Returns the created guest.
| Argument | Type | Description |
|---|---|---|
| notes | string | Free-text notes on the guest. |
| fields | object | Additional documented OwnerRez fields to send in the JSON write body (merged with the typed fields above). |
| last_name | string | Guest last name. |
| first_name | string | Guest first name. |
| opt_out_marketing_sms | boolean | Opt this guest out of marketing SMS. |
| opt_out_marketing_email | boolean | Opt this guest out of marketing email. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"notes": {
"type": "string",
"description": "Free-text notes on the guest."
},
"fields": {
"type": "object",
"description": "Additional documented OwnerRez fields to send in the JSON write body (merged with the typed fields above).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"last_name": {
"type": "string",
"description": "Guest last name."
},
"first_name": {
"type": "string",
"description": "Guest first name."
},
"opt_out_marketing_sms": {
"type": "boolean",
"description": "Opt this guest out of marketing SMS."
},
"opt_out_marketing_email": {
"type": "boolean",
"description": "Opt this guest out of marketing email."
}
}
}MUTATES OwnerRez data: posts a message into a guest-communication thread. OwnerRez API: POST /v2/messages (JSON). The exact thread/booking linkage is account-specific — pass extra documented fields (e.g. thread_id, booking_id) via `fields`. Returns the created message.
| Argument | Type | Description |
|---|---|---|
| body* | string | The message text/body (required). |
| fields | object | Additional documented OwnerRez fields to send in the JSON write body (merged with the typed fields above). |
| booking_id | integer | The booking this message relates to. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"body"
],
"properties": {
"body": {
"type": "string",
"description": "The message text/body (required)."
},
"fields": {
"type": "object",
"description": "Additional documented OwnerRez fields to send in the JSON write body (merged with the typed fields above).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"booking_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The booking this message relates to."
}
}
}MUTATES OwnerRez data: creates a quote for a property + date range (the pre-booking pricing document). OwnerRez API: POST /v2/quotes (JSON). The full quote/charge shape is account-specific — pass extra documented fields via `fields`. Returns the created quote.
| Argument | Type | Description |
|---|---|---|
| adults | integer | Number of adults. |
| fields | object | Additional documented OwnerRez fields to send in the JSON write body (merged with the typed fields above). |
| arrival | string | Arrival/check-in date (ISO-8601). |
| children | integer | Number of children. |
| guest_id | integer | The guest id, if quoting for an existing guest. |
| departure | string | Departure/check-out date (ISO-8601). |
| property_id* | integer | The property to quote (required). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"property_id"
],
"properties": {
"adults": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Number of adults."
},
"fields": {
"type": "object",
"description": "Additional documented OwnerRez fields to send in the JSON write body (merged with the typed fields above).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"arrival": {
"type": "string",
"description": "Arrival/check-in date (ISO-8601)."
},
"children": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Number of children."
},
"guest_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The guest id, if quoting for an existing guest."
},
"departure": {
"type": "string",
"description": "Departure/check-out date (ISO-8601)."
},
"property_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The property to quote (required)."
}
}
}Fetch a single booking by id. OwnerRez API: GET /v2/bookings/{id}. Opt into embedded charges/guest/tags.
| Argument | Type | Description |
|---|---|---|
| id* | integer | The booking id. |
| include_tags | boolean | Include the tags collection. |
| include_guest | boolean | Include the embedded guest object. |
| include_charges | boolean | Include the charges breakdown. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The booking id."
},
"include_tags": {
"type": "boolean",
"description": "Include the tags collection."
},
"include_guest": {
"type": "boolean",
"description": "Include the embedded guest object."
},
"include_charges": {
"type": "boolean",
"description": "Include the charges breakdown."
}
}
}Fetch a single guest (contact) by id. OwnerRez API: GET /v2/guests/{id}.
| Argument | Type | Description |
|---|---|---|
| id* | integer | The guest id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The guest id."
}
}
}Fetch a single channel listing by id. OwnerRez API: GET /v2/listings/{id}.
| Argument | Type | Description |
|---|---|---|
| id* | integer | The listing id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The listing id."
}
}
}Return the authenticated OwnerRez user (verifies your credentials). OwnerRez API: GET /v2/users/me.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Fetch a single payment by id. OwnerRez API: GET /v2/payments/{id}.
| Argument | Type | Description |
|---|---|---|
| id* | integer | The payment id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The payment id."
}
}
}Fetch a single property by id (includes time_zone). OwnerRez API: GET /v2/properties/{id}.
| Argument | Type | Description |
|---|---|---|
| id* | integer | The property id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The property id."
}
}
}Fetch a single quote by id. OwnerRez API: GET /v2/quotes/{id}.
| Argument | Type | Description |
|---|---|---|
| id* | integer | The quote id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The quote id."
}
}
}List bookings (reservations). OwnerRez API: GET /v2/bookings. Filter by property, date range, changed-since, and status; opt into embedded charges/guest/tags. Returns { items, count, limit, offset, next_page_url }.
| Argument | Type | Description |
|---|---|---|
| to | string | End of the arrival/stay date window (ISO-8601). |
| from | string | Start of the arrival/stay date window (ISO-8601, e.g. 2026-07-01). |
| limit | integer | Max items to return per page (default set by OwnerRez, typically 10). |
| offset | integer | Number of items to skip (for paging; combine with limit). |
| params | object | Additional documented query-string filters to send verbatim (merged with the typed params above). |
| status | string | Filter by booking status. |
| since_utc | string | Only bookings created/updated on or after this UTC timestamp (ISO-8601). |
| include_tags | boolean | Include the tags collection on each booking. |
List custom-field definitions available in the account (the schema for custom fields on properties/bookings/guests). OwnerRez API: GET /v2/fielddefinitions.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max items to return per page (default set by OwnerRez, typically 10). |
| offset | integer | Number of items to skip (for paging; combine with limit). |
| params | object | Additional documented query-string filters to send verbatim (merged with the typed params above). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Max items to return per page (default set by OwnerRez, typically 10)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Number of items to skip (for paging; combine with limit)."
},
"params": {
"type": "object",
"description": "Additional documented query-string filters to send verbatim (merged with the typed params above).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
}
}
}
}List guests (contacts). OwnerRez API: GET /v2/guests. NOTE: OwnerRez REQUIRES either `q` (search) or `created_since_utc` on this endpoint. Returns { items, count, limit, offset, next_page_url }.
| Argument | Type | Description |
|---|---|---|
| q | string | Search query across guest name/email (required unless created_since_utc is set). |
| to | string | Filter to guests arriving on or before this date (ISO-8601). |
| from | string | Filter to guests departing on or after this date (ISO-8601). |
| limit | integer | Max items to return per page (default set by OwnerRez, typically 10). |
| offset | integer | Number of items to skip (for paging; combine with limit). |
| params | object | Additional documented query-string filters to send verbatim (merged with the typed params above). |
| include_tags | boolean | Include the tags collection on each guest. |
| include_fields | boolean | Include the custom-fields collection on each guest. |
List guest inquiries (pre-booking leads). OwnerRez API: GET /v2/inquiries. Use `params` for documented filters.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max items to return per page (default set by OwnerRez, typically 10). |
| offset | integer | Number of items to skip (for paging; combine with limit). |
| params | object | Additional documented query-string filters to send verbatim (merged with the typed params above). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Max items to return per page (default set by OwnerRez, typically 10)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Number of items to skip (for paging; combine with limit)."
},
"params": {
"type": "object",
"description": "Additional documented query-string filters to send verbatim (merged with the typed params above).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
}
}
}
}List the listing sites (channels, e.g. Airbnb, Vrbo) known to OwnerRez. OwnerRez API: GET /v2/listingsites.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max items to return per page (default set by OwnerRez, typically 10). |
| offset | integer | Number of items to skip (for paging; combine with limit). |
| params | object | Additional documented query-string filters to send verbatim (merged with the typed params above). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Max items to return per page (default set by OwnerRez, typically 10)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Number of items to skip (for paging; combine with limit)."
},
"params": {
"type": "object",
"description": "Additional documented query-string filters to send verbatim (merged with the typed params above).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
}
}
}
}List channel listings (a property's presence on a listing site such as Airbnb/Vrbo). OwnerRez API: GET /v2/listings. Returns { items, count, limit, offset, next_page_url }.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max items to return per page (default set by OwnerRez, typically 10). |
| offset | integer | Number of items to skip (for paging; combine with limit). |
| params | object | Additional documented query-string filters to send verbatim (merged with the typed params above). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Max items to return per page (default set by OwnerRez, typically 10)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Number of items to skip (for paging; combine with limit)."
},
"params": {
"type": "object",
"description": "Additional documented query-string filters to send verbatim (merged with the typed params above).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
}
}
}
}List messages from guest-communication threads. OwnerRez API: GET /v2/messages. Use `params` for documented filters (e.g. booking_id).
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max items to return per page (default set by OwnerRez, typically 10). |
| offset | integer | Number of items to skip (for paging; combine with limit). |
| params | object | Additional documented query-string filters to send verbatim (merged with the typed params above). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Max items to return per page (default set by OwnerRez, typically 10)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Number of items to skip (for paging; combine with limit)."
},
"params": {
"type": "object",
"description": "Additional documented query-string filters to send verbatim (merged with the typed params above).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
}
}
}
}List property owners. OwnerRez API: GET /v2/owners. Returns { items, count, limit, offset, next_page_url }.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max items to return per page (default set by OwnerRez, typically 10). |
| offset | integer | Number of items to skip (for paging; combine with limit). |
| params | object | Additional documented query-string filters to send verbatim (merged with the typed params above). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Max items to return per page (default set by OwnerRez, typically 10)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Number of items to skip (for paging; combine with limit)."
},
"params": {
"type": "object",
"description": "Additional documented query-string filters to send verbatim (merged with the typed params above).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
}
}
}
}List payments. OwnerRez API: GET /v2/payments. Use `params` for documented filters (e.g. booking_id, since_utc).
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max items to return per page (default set by OwnerRez, typically 10). |
| offset | integer | Number of items to skip (for paging; combine with limit). |
| params | object | Additional documented query-string filters to send verbatim (merged with the typed params above). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Max items to return per page (default set by OwnerRez, typically 10)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Number of items to skip (for paging; combine with limit)."
},
"params": {
"type": "object",
"description": "Additional documented query-string filters to send verbatim (merged with the typed params above).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
}
}
}
}List rental properties. OwnerRez API: GET /v2/properties. Returns the pageable envelope { items, count, limit, offset, next_page_url }.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max items to return per page (default set by OwnerRez, typically 10). |
| active | boolean | Filter by active status (true = only active properties). |
| offset | integer | Number of items to skip (for paging; combine with limit). |
| params | object | Additional documented query-string filters to send verbatim (merged with the typed params above). |
| include_tags | boolean | Include the tags collection on each property. |
| include_fields | boolean | Include the custom-fields collection on each property. |
| payment_method_id | integer | Filter by applicable payment method id. |
| availability_end_date | string | Filter by availability end date (ISO-8601). |
List quotes. OwnerRez API: GET /v2/quotes. Returns { items, count, limit, offset, next_page_url }. Use the `params` passthrough for documented filters (e.g. property_id, guest_id).
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max items to return per page (default set by OwnerRez, typically 10). |
| offset | integer | Number of items to skip (for paging; combine with limit). |
| params | object | Additional documented query-string filters to send verbatim (merged with the typed params above). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Max items to return per page (default set by OwnerRez, typically 10)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Number of items to skip (for paging; combine with limit)."
},
"params": {
"type": "object",
"description": "Additional documented query-string filters to send verbatim (merged with the typed params above).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
}
}
}
}Power-user escape hatch: GET any OwnerRez API path not wrapped by a dedicated tool. READ-ONLY — only GET is allowed. Pass the FULL API path after the host, starting with a slash, INCLUDING any query string, e.g. "/v2/propertysearch?query=beach" or "/v2/bookings/123". Returns the parsed JSON.
| Argument | Type | Description |
|---|---|---|
| path* | string | Full API path after the host, starting with "/", e.g. "/v2/properties?limit=1". |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"path"
],
"properties": {
"path": {
"type": "string",
"description": "Full API path after the host, starting with \"/\", e.g. \"/v2/properties?limit=1\"."
}
}
}MUTATES OwnerRez data: updates an existing booking. OwnerRez API: PATCH /v2/bookings/{id} (JSON — only included fields change). Use the `fields` passthrough for any documented field (dates, guest counts, notes, status).
| Argument | Type | Description |
|---|---|---|
| id* | integer | The booking id to update (required). |
| notes | string | New notes value. |
| adults | integer | New adult count. |
| fields | object | Additional documented OwnerRez fields to send in the JSON write body (merged with the typed fields above). |
| arrival | string | New arrival date (ISO-8601). |
| children | integer | New child count. |
| departure | string | New departure date (ISO-8601). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The booking id to update (required)."
},
"notes": {
"type": "string",
"description": "New notes value."
},
"adults": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "New adult count."
},
"fields": {
"type": "object",
"description": "Additional documented OwnerRez fields to send in the JSON write body (merged with the typed fields above).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"arrival": {
"type": "string",
"description": "New arrival date (ISO-8601)."
},
"children": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "New child count."
},
"departure": {
"type": "string",
"description": "New departure date (ISO-8601)."
}
}
}MUTATES OwnerRez data: updates an existing guest. OwnerRez API: PATCH /v2/guests/{id} (JSON — only included fields change). Use the `fields` passthrough for arrays (email_addresses/phones/addresses) and any other documented field.
| Argument | Type | Description |
|---|---|---|
| id* | integer | The guest id to update (required). |
| notes | string | New notes value. |
| fields | object | Additional documented OwnerRez fields to send in the JSON write body (merged with the typed fields above). |
| last_name | string | New last name. |
| first_name | string | New first name. |
| opt_out_marketing_sms | boolean | Opt-out flag for marketing SMS. |
| opt_out_marketing_email | boolean | Opt-out flag for marketing email. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The guest id to update (required)."
},
"notes": {
"type": "string",
"description": "New notes value."
},
"fields": {
"type": "object",
"description": "Additional documented OwnerRez fields to send in the JSON write body (merged with the typed fields above).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"last_name": {
"type": "string",
"description": "New last name."
},
"first_name": {
"type": "string",
"description": "New first name."
},
"opt_out_marketing_sms": {
"type": "boolean",
"description": "Opt-out flag for marketing SMS."
},
"opt_out_marketing_email": {
"type": "boolean",
"description": "Opt-out flag for marketing email."
}
}
}| property_ids |
| string |
| Comma-separated property id(s) to filter by, e.g. "123" or "123,456". |
| include_guest | boolean | Include the embedded guest object on each booking. |
| include_fields | boolean | Include the custom-fields collection on each booking. |
| include_charges | boolean | Include the charges breakdown on each booking. |
| include_cancellation_policy | boolean | Include the cancellation-policy detail. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"to": {
"type": "string",
"description": "End of the arrival/stay date window (ISO-8601)."
},
"from": {
"type": "string",
"description": "Start of the arrival/stay date window (ISO-8601, e.g. 2026-07-01)."
},
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Max items to return per page (default set by OwnerRez, typically 10)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Number of items to skip (for paging; combine with limit)."
},
"params": {
"type": "object",
"description": "Additional documented query-string filters to send verbatim (merged with the typed params above).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
}
},
"status": {
"enum": [
"active",
"canceled",
"pending"
],
"type": "string",
"description": "Filter by booking status."
},
"since_utc": {
"type": "string",
"description": "Only bookings created/updated on or after this UTC timestamp (ISO-8601)."
},
"include_tags": {
"type": "boolean",
"description": "Include the tags collection on each booking."
},
"property_ids": {
"type": "string",
"description": "Comma-separated property id(s) to filter by, e.g. \"123\" or \"123,456\"."
},
"include_guest": {
"type": "boolean",
"description": "Include the embedded guest object on each booking."
},
"include_fields": {
"type": "boolean",
"description": "Include the custom-fields collection on each booking."
},
"include_charges": {
"type": "boolean",
"description": "Include the charges breakdown on each booking."
},
"include_cancellation_policy": {
"type": "boolean",
"description": "Include the cancellation-policy detail."
}
}
}| created_since_utc |
| string |
| Only guests created on or after this UTC timestamp (ISO-8601). Required unless q is set. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"description": "Search query across guest name/email (required unless created_since_utc is set)."
},
"to": {
"type": "string",
"description": "Filter to guests arriving on or before this date (ISO-8601)."
},
"from": {
"type": "string",
"description": "Filter to guests departing on or after this date (ISO-8601)."
},
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Max items to return per page (default set by OwnerRez, typically 10)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Number of items to skip (for paging; combine with limit)."
},
"params": {
"type": "object",
"description": "Additional documented query-string filters to send verbatim (merged with the typed params above).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
}
},
"include_tags": {
"type": "boolean",
"description": "Include the tags collection on each guest."
},
"include_fields": {
"type": "boolean",
"description": "Include the custom-fields collection on each guest."
},
"created_since_utc": {
"type": "string",
"description": "Only guests created on or after this UTC timestamp (ISO-8601). Required unless q is set."
}
}
}| availability_start_date |
| string |
| Filter by availability start date (ISO-8601, e.g. 2026-07-01). |
| include_listing_numbers | boolean | Include channel listing numbers on each property. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Max items to return per page (default set by OwnerRez, typically 10)."
},
"active": {
"type": "boolean",
"description": "Filter by active status (true = only active properties)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Number of items to skip (for paging; combine with limit)."
},
"params": {
"type": "object",
"description": "Additional documented query-string filters to send verbatim (merged with the typed params above).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
}
},
"include_tags": {
"type": "boolean",
"description": "Include the tags collection on each property."
},
"include_fields": {
"type": "boolean",
"description": "Include the custom-fields collection on each property."
},
"payment_method_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Filter by applicable payment method id."
},
"availability_end_date": {
"type": "string",
"description": "Filter by availability end date (ISO-8601)."
},
"availability_start_date": {
"type": "string",
"description": "Filter by availability start date (ISO-8601, e.g. 2026-07-01)."
},
"include_listing_numbers": {
"type": "boolean",
"description": "Include channel listing numbers on each property."
}
}
}