Overview

This page addresses the most common questions developers ask when working with the CiiRUS-API. Whether you're just getting started or troubleshooting a live integration, these answers will help guide your success.

1. 🔐 Why am I having trouble accessing the API?

API access is controlled by two key factors:

• API Username and Password, assigned at the account level.
• IP Whitelisting, which restricts access to only approved IP addresses for that account.

If you're experiencing access issues, confirm that you're using the correct credentials provided in your API Welcome Email. If credentials are correct, the issue is likely due to an unregistered IP address. In that case, contact CiiRUS Technical Support at [email protected] to verify your whitelisted IPs.

2. 🔌 How do I integrate the API into my system?

Start by identifying the endpoints that align with your business needs (units, unit_details, availability, reservations, etc.). Reference the CiiRUS-API Introduction pages to plan your integration. We recommend building with read-only endpoints first and testing thoroughly before moving into write actions.

📘

See our Suggested Workflow for typical a typical workflow and recommended sequencing.

3. 📦 How do I retrieve property data, availability, and reservations?

The CiiRUS-API provides data via structured GET endpoints:

Unit information is accessed through a combination of endpoints, depending on the level of detail required:

• /units endpoint – Returns high-level data about each unit in your inventory. This includes identifiers, status flags, location info, rate settings, booking configuration, and integration metadata such as Airbnb or Vrbo sync settings.
• /unit_details endpoint – Returns more in-depth information for each unit, such as detailed descriptions, address data, guest policies, check-in/out times, restrictions, secure codes (where applicable), and additional metadata related to channels and tax settings.
• For additional unit details, refer to the endpoints below:
  • Unit amenities are returned via the /unit_amenities endpoint.
  • Unit Images are retrieved using the /unit_images endpoint.

For other unit-related data:

• Availability is returned via the /unit_calendars endpoint.
• Rates are retrieved using the /unit_rental endpoint.

For additional unit charge and quote details, refer to the endpoints below:

• Unit Extras are retrieved using the /unit_extras endpoint.
• Unit Taxes are returned via the /unit_taxes endpoint.
• Unit Quote Settings are retrieved using the /unit_quotes endpoint.

📘

Use date filters or last-update parameters wherever available to reduce payload size and optimize performance.

4. 🚀 Why is the API response slow or timing out?

Performance issues are typically related to unfiltered or large-scale requests. To improve response times:

• Use parameters like last_unit_update_date, last_reservation_update_date, or date ranges.
• Avoid sending bulk requests without pagination (or no_total parameter set true).
• Spread out high-volume operations (e.g., rebuilding all units), and queue requests during off-peak hours (1900 –0700 Eastern Time).

🚧

If you’ve made these adjustments and are still experiencing latency, contact [email protected] for further analysis.

5. 🧾 What do API error responses mean?

CiiRUS uses standard HTTP error codes (e.g., 401, 403, 500) for transport-level errors. However, you may also receive a 200 OK response with an embedded error object—this indicates the request was received but the business logic failed. In these cases, refer to the "error" and "message" in the response body for details.

📘

Always log and review both the HTTP status and response body for complete context.

6. 🔄 How do I migrate to a newer version of the API?

CiiRUS strives to maintain backward compatibility where possible. For any breaking changes or version deprecations, we maintain an up-to-date API Changelog. Review this regularly and plan to test new versions in a controlled environment before pushing updates to production. Refer to the Migration Guide pages to plan your migration accordingly.

7. 📚 Where can I find API documentation?

The API Documentation portal includes all current endpoints, parameters, response schemas, and sample payloads.
We are actively expanding and updating these guides to ensure they’re aligned with the newest API version.

📘

Explore the What's New page and Changelog to stay current.

8. 🔐 Is the API secure and compliant with industry standards?

Yes. All CiiRUS API traffic is encrypted over HTTPS, and API credentials are scoped per account. Access is IP-restricted, and our systems are designed with modern security practices in mind.

9. 🧪 Is there a sandbox environment for testing?

Yes, a Sandbox PMC Account is available to support development and testing without affecting live production data. To request access for connection, contact [email protected] with your MCUser ID or API Username.

10. 🧠 What information should I include when contacting support?

If you require assistance, please reach out via Intercom or by email at [email protected] and include the following:

• Your Account Username, ID (MCUserID), or API Username – to identify your account.
• Any Supplier(s) involved – if relevant to your integration.
• The specific API endpoint and request type – e.g., GET /reservations.
• Parameters in the endpoint URL – used in the call you made.
• X-AMZ-GUID Header of the response – if applicable, this helps us trace the request.
• For 5xx errors – include the full endpoint and the timestamp of the failed request.
• Detailed description of the issue – including any error messages or unexpected behavior.

The more specific you can be, the faster we can help resolve your issue.