How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
GuestReady

GuestReady Reservations API

The reservations API from GuestReady — 6 operation(s) for reservations.

Documentation Provider Profile APIs.io OpenAPI GitHub

GuestReady Reservations API is one of 62 APIs that GuestReady publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Reservations. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and a getting-started guide.

This API exposes 9 operations across 6 paths, and defines 25 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/.

9 operations 6 paths 25 schemas 3 GET4 PATCH2 POST

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 Reservations 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 9

Across 6 paths, the API surfaces 9 operations — 3 GET, 4 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

reservations 9
GET
/api/v3/reservations/
Mixin that adds custom-fields GET/POST actions to entity ViewSets.
reservations_list 17 params → 200
POST
/api/v3/reservations/
Mixin that adds custom-fields GET/POST actions to entity ViewSets.
reservations_create 1 param body → 201
GET
/api/v3/reservations/{id}/
Mixin that adds custom-fields GET/POST actions to entity ViewSets.
reservations_retrieve 2 params → 200
PATCH
/api/v3/reservations/{id}/
Mixin that adds custom-fields GET/POST actions to entity ViewSets.
reservations_partial_update 2 params body → 200
PATCH
/api/v3/reservations/{id}/cancel/
Mixin that adds custom-fields GET/POST actions to entity ViewSets.
reservations_cancel_partial_update 2 params → 200
GET
/api/v3/reservations/{id}/custom_fields/
Get the custom-field values set on this object, as a mapping of custom field key to value.
reservations_custom_fields_retrieve 2 params → 200
POST
/api/v3/reservations/{id}/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.
reservations_custom_fields_create 2 params body → 200
PATCH
/api/v3/reservations/{id}/update_arrival_time/
Update the expected guest arrival time. The check-in mission is rescheduled and its assigned agent asked to re-confirm. No guest notification is sent: when latecheckinpaymentpending comes back true,…
reservations_update_arrival_time_partial_update 2 params body → 200
PATCH
/api/v3/reservations/{id}/update_key_code/
Mixin that adds custom-fields GET/POST actions to entity ViewSets.
reservations_update_key_code_partial_update 2 params body → 200400

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are Reservation (75 properties), PatchedReservationCreate (41 properties), ReservationCreate (41 properties), MidTermPeriodBreakdown (10 properties). Each schema is shown below with its type and property counts.

Status3eaEnum
string
TENTATIVE - Tentative NEW - New ARCHIVED - Archived CANCELLED - Cancelled CANCELLEDFEE - Cancelled with fee
SwiklyDepositEmbedded
object
2 properties 2 required
BlockedReasonEnum
string
HOSTSTAY - Owner stay MAINTENANCE - Maintenance OTHER - Other PARTIALOCCUPANCY - Partially occupied FULLOCCUPANCY - Fully occupied BLOCKEDBYHOST - Blocked by o…
Status1a4Enum
string
AUTHORIZED - Authorized NOTPAID - Not paid PAID - Paid FAILED - Failed VOIDED - Voided PROCESSED - Processed
PaidToEnum
string
HOST - Owner PROPERTYMANAGER - Property manager
PaginatedReservationList
object
5 properties 1 required
ReservationCreate
object
41 properties 17 required
MidTermPeriodBreakdown
object
10 properties 10 required
GuestInvoice
object
7 properties 1 required
VoucherRedemption
object
2 properties 2 required
Reservation
object
Renders custom-field values under customfields, skipped on list actions.
75 properties 47 required
CurrencyD53Enum
string
AED - AED AUD - AUD BRL - BRL CAD - CAD CHF - CHF CZK - CZK EUR - EUR GBP - GBP HKD - HKD IDR - IDR ILS - ILS JPY - JPY KRW - KRW MAD - MAD MYR - MYR PLN - PLN…
ExtraFee
object
2 properties 2 required
ReturnCleaningEnum
string
FULLOWNER - Full cleaning + Owner bedding FULLPROPERTYMANAGER - Full cleaning + Property manager bedding
ReservationTypeEnum
string
CLASSIQUE - CLASSIQUE FAUSSE - FAUSSE PROPRIETAIRE - PROPRIETAIRE
PatchedReservationCreate
object
41 properties
BlankEnum
Status6f9Enum
string
NOTPAID - NOTPAID PAID - PAID
PaymentLinkSecurityDeposit
object
3 properties 1 required
DepartureCleaningEnum
string
FULLOWNER - Full cleaning + Owner bedding FULLPROPERTYMANAGER - Full cleaning + Property manager bedding DELIVERY - Delivery (No cleaning + Property manager be…
NullEnum
ReservationStatusEnum
string
pending - pending accepted - accepted cancelled - cancelled
PatchedReservationArrivalTimeUpdate
object
Set the expected guest arrival time, and nothing else.
1 property
IdVerificationStatusEnum
string
NOTVERIFIED - NOTVERIFIED PENDING - PENDING VERIFIED - VERIFIED FAILED - FAILED
ReservationExtraFee
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

guestready-reservations-api-openapi.yml Raw ↑

Other APIs GuestReady publishes across the network.

GuestReady Accounting Invoices API
AE Profile APIs.io
GuestReady Amenities API
AE Profile APIs.io
GuestReady Bathrooms API
AE Profile APIs.io
GuestReady Bed Types API
AE Profile APIs.io
GuestReady Bedrooms API
AE Profile APIs.io
GuestReady Blacklist API
AE Profile APIs.io
GuestReady Calendar API
AE Profile APIs.io
GuestReady Check In Steps API
AE Profile APIs.io
GuestReady Cities API
AE Profile APIs.io
GuestReady City Tax Rules API
AE Profile APIs.io
GuestReady Conversations API
AE Profile APIs.io
GuestReady Countries API
AE Profile APIs.io
#Reservations
← Back to G APIs
API Details
ID
guestready:guestready-reservations-api
Base URL
https://pms.rentalready.io/api/v3/
Docs
https://pms.rentalready.io/api/v3/schema/swagger-ui/
Provider
GuestReady
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

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.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=guestready-reservations-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/guestready-reservations-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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 Reservations 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.