GuestReady Rentals API is one of 62 APIs that GuestReady publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Rentals. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and a getting-started guide.
This API exposes
17 operations
across 11 paths,
and defines 44 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0 (api).
Requests are made against a single base URL, https://pms.rentalready.io/api/v3/.
17 operations11 paths44 schemas2 DELETE5 GET4 PATCH5 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.2.0
API Version
1.0.0 (api)
Base URL
https://pms.rentalready.io/api/v3/
Authentication
HTTP Basic, API Key, OAuth 2.0, API Key
Resource Areas
1
Authentication & Security 4
GuestReady Rentals API declares
4 security schemes
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
An API key is passed in the cookie as sessionid (cookieAuth).
It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 52 scopes.
An API key is passed in the header as Authorization (tokenAuth).
tokenAuth — Token-based authentication with required prefix "Token"
Paths & Operations 17
Across 11 paths, the API surfaces 17 operations — 2 DELETE, 5 GET, 4 PATCH, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
rentals 17
GET
/api/v3/rentals/
Mixin that adds custom-fields GET/POST actions to entity ViewSets.
rentals_list20 params→ 200
POST
/api/v3/rentals/
Create a rental in status onboarding, to fill it with all required data
rentals_createbody→ 201
GET
/api/v3/rentals/{numero_contrat}/
Mixin that adds custom-fields GET/POST actions to entity ViewSets.
rentals_retrieve1 param→ 200
PUT
/api/v3/rentals/{numero_contrat}/
Update a rental
rentals_update1 parambody→ 200
PATCH
/api/v3/rentals/{numero_contrat}/
Update a rental
rentals_partial_update1 parambody→ 200
DELETE
/api/v3/rentals/{numero_contrat}/
Mixin that adds custom-fields GET/POST actions to entity ViewSets.
rentals_destroy1 param→ 204
PATCH
/api/v3/rentals/{numero_contrat}/block/
Block calendar
rentals_block_partial_update1 parambody→ 200
GET
/api/v3/rentals/{numero_contrat}/custom_fields/
Get the custom-field values set on this object, as a mapping of custom field key to value.
rentals_custom_fields_retrieve1 param→ 200
POST
/api/v3/rentals/{numero_contrat}/custom_fields/
Set custom-field values on this object. Send a mapping of custom field key to value; keys left out keep their current value, and a key with no definition on this account is rejected.
Update the upselling configuration assigned to the property. The configuration must be one of those connected to the property's office; pass null to clear the assignment.
The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are PatchedRental (230 properties), Rental (229 properties), CreateRental (28 properties), GuestControl (10 properties). Each schema is shown below with its type and property counts.
RentalPhoto
object
1 property1 required
RentalInvoiceDetails
object
8 properties6 required
BuildingConstructionPeriodEnum
string
BEFORE1949 - before 1949 FROM1949TO1974 - from 1949 to 1974 FROM1975TO1989 - from 1975 to 1989 FROM1989TO2005 - from 1989 to 2005 AFTER2005 - after 2005
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of GuestReady Rentals API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
