API Reference

Good to know: An API guide can be good to help folks get up and running with our API in a few steps.

Get your API keys

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

You can get an API key from us by signing up for an developer account.

Make your first API request

Authentication method, where previously generated API Key is used to sign requests:

Retrieve list of properties associated with the API Key.

GET https://hotelcm-api-dev.zimple.cloud/api/v1/properties/

Headers

Name	Type	Description
user-api-key*	String

200: OK

401: Unauthorized

Take a look at how you might call this method:

Sample Request

GET https://hotelcm-api-dev.zimple.cloud/api/v1/properties HTTP/1.1
Host: hotelcm-api-dev.zimple.cloud
Content-Type: application/json
user-api-key: uZadcd4Vk1AopfxMyoyvstNRe1x4DIKlgnRQTTJ+j5ksJ5wLIg1Kif4l7UDbk7O4

Errors

We employ standard HTTP response codes to signify whether an API request was successful or unsuccessful. Broadly speaking, response codes in the 2xx range denote success. Codes falling within the 4xx range signal an error caused by shortcomings in the provided information (e.g., missing required parameters, validation errors, etc.). Meanwhile, codes in the 5xx range signify a server-related error, prompting a recommendation to retry the request.

{
  "errors": {
    "code": "validation_error",
    "title": "Validation Error",
    "details": {
      "is_active": [
        "can't be blank"
      ]
    }
  }
}