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 Missions API

The missions API from GuestReady — 10 operation(s) for missions.

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

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

This API exposes 12 operations across 10 paths, and defines 18 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/.

12 operations 10 paths 18 schemas 4 GET7 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 Missions 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 12

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

missions 12
GET
/api/v3/agents/
List agents
agents_list 7 params → 200
GET
/api/v3/agents/{id}/
Retrieve agent
agents_retrieve 1 param → 200
GET
/api/v3/missions/
missions_list 9 params → 200
POST
/api/v3/missions/
missions_create body → 201
GET
/api/v3/missions/{id}/
missions_retrieve 1 param → 200
PATCH
/api/v3/missions/{id}/
missions_partial_update 1 param body → 200
PATCH
/api/v3/missions/{id}/cancel/
missions_cancel_partial_update 1 param body → 200
PATCH
/api/v3/missions/{id}/mark_mission_as_done/
missions_mark_mission_as_done_partial_update 1 param body → 200
PATCH
/api/v3/missions/{id}/update_agent/
missions_update_agent_partial_update 1 param body → 200
PATCH
/api/v3/missions/{id}/update_end_time/
Update the mission end time. Both end and editcomment are required, and the new end cannot precede the mission start.
missions_update_end_time_partial_update 1 param body → 200
PATCH
/api/v3/missions/{id}/update_external_comment/
missions_update_external_comment_partial_update 1 param body → 200
PATCH
/api/v3/missions/{id}/update_start_time/
Update the mission start time, keeping its duration. Both start and editcomment are required.
missions_update_start_time_partial_update 1 param body → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are Mission (30 properties), PatchedMission (30 properties), MissionPayoutAdjustment (12 properties), KeyCollectionCode (6 properties). Each schema is shown below with its type and property counts.

KeyCollectionCode
object
6 properties 5 required
BlankEnum
ActiveStatusEnum
string
PENDING - PENDING DOING - DOING DONE - DONE
PaginatedAgentList
object
5 properties 2 required
PatchedUpdateMissionStartTime
object
Base for the updatestarttime / updateendtime actions. Subclasses declare their own datetime field and move it onto the mission in applynewtime; the audit comme…
2 properties
RequestedMaintenanceJobEnum
string
MissionPayoutAdjustmentCategoryEnum
string
cleaning - cleaning maintenance - maintenance improvement - improvement qualitycheck - qualitycheck issueresolution - issueresolution onboardingfee - onboardin…
AgentStatusEnum
string
ACTIVE - Active INACTIVE - Inactive
Mission
object
30 properties 14 required
NullEnum
PatchedMission
object
30 properties
PaymentStatusEnum
string
NOTPAID - Not paid PAID - Paid
MissionStatusEnum
string
NEW - New ASSIGNED - Assigned PENDINGCH - Awaiting validation after a change CANCELLED - Cancelled ARCHIVED - Archived
Agent
object
Read-only lookup: who the caller may put on a mission, and their id. An allowlist, not the model: no phone, address, date of birth or identity document. antenn…
6 properties 4 required
MissionPayoutAdjustment
object
12 properties 6 required
PatchedUpdateMissionEndTime
object
Base for the updatestarttime / updateendtime actions. Subclasses declare their own datetime field and move it onto the mission in applynewtime; the audit comme…
2 properties
ChargedToEnum
string
PROPERTYMANAGER - Property Manager OWNER - Owner GUEST - Guest PROVIDERS - Providers
PaginatedMissionList
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

guestready-missions-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 Conversations API
GuestReady Countries API
Where this information came from

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