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

GuestReady Conversations API

The Conversations API from GuestReady — 5 operation(s) for conversations.

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

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

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

6 operations 5 paths 7 schemas 4 GET1 PATCH1 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 Conversations 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 6

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

Conversations 6
GET
/api/v3/conversation_flags/
List conversation flags
conversation_flags_list 2 params → 200
GET
/api/v3/conversation_flags/{id}/
Retrieve conversation flag
conversation_flags_retrieve 1 param → 200
GET
/api/v3/conversations/
List conversations
conversations_list 9 params → 200
POST
/api/v3/conversations/
Create conversation
conversations_create body → 201
GET
/api/v3/conversations/{id}/
Retrieve conversation
conversations_retrieve 1 param → 200
PATCH
/api/v3/conversations/{id}/set_flag/
Set conversation flag
conversations_set_flag_partial_update 1 param body → 200400403

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Conversation (17 properties), PaginatedConversationList (5 properties), ConversationCreate (5 properties), PaginatedConversationFlagList (5 properties). Each schema is shown below with its type and property counts.

PaginatedConversationFlagList
object
5 properties 2 required
Conversation
object
17 properties 17 required
StatusFa3Enum
string
merged - Merged opened - Opened closed - Closed
PatchedSetConversationFlag
object
Write serializer for the setflag action: one field, no silent no-op. Bound to the conversation instance (like the incident status-change serializers): update d…
1 property
ConversationFlag
object
A triage flag, named AS THE CALLER'S PROPERTY MANAGER SEES IT. The rows themselves are global reference data (every tenant flags against the same handful of fl…
3 properties 3 required
ConversationCreate
object
5 properties 1 required
PaginatedConversationList
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

guestready-conversations-api-openapi.yml Raw ↑

Other APIs GuestReady publishes across the network.

GuestReady Accounting Invoices API
GuestReady Amenities API
GuestReady Bathrooms API
GuestReady Bed Types API
GuestReady Bedrooms API
GuestReady Blacklist API
GuestReady Calendar API
GuestReady Check In Steps API
GuestReady Cities API
GuestReady City Tax Rules API
GuestReady Countries API
GuestReady Custom Fields API
Where this information came from

This is an independent, third-party profile of GuestReady Conversations 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.