Skip to content

API Help

Introduction

Retain Cloud APIs let you integrate Retain Cloud services into your platform.

The following Help pages provide you with all the information you need to start using Retain Cloud APIs. Use these help pages in conjunction with the API Help Docs.

Your API Help Docs link will depend on where your application is hosted:

To access the API Help Docs you will require a valid user account and your Company ID (also referred to as Tenant ID - see below).

Note

The Company IDs are case sensitive and must be entered in the correct case with a valid user account to access the API Help Docs.

Understand tenant and environment

The IDs and Resource URL specified in the API Help pages are tenant dependent. For example, tenant specific details will replace 'TenantID' and 'Environment' in the Resource URL specified below:

https://{environment}.retaincloud.com/DataAccessAPI/{tenant}/api/tableaccess/booking.

Your environment will depend on where your application is hosted.

If in doubt about your environment, look at the URL you use to access Retain Cloud. The part before "retaincloud" will be your environment.

For example, consider the following URL: https://us.retaincloud.com/client1/plans.

The environment will be "US" and the tenant will be "client1" in this case.

The booking_guids and other ids returned by responses shown in the examples are also tenant dependant.

Note

As of version 2.0 of Retain Cloud there is a new format for APIs. Legacy APIs are still supported in parallel and these will be deprecated in a future release. Legacy APIs will be marked as Legacy in the help documentation.