---
title: "Getting started"
description: "Get credentials, make your first Partner API request and explore the demo data."
url: "https://portal.konghotels.cloud/getting-started"
image: "https://portal.konghotels.cloud/_og/d/c_Ocean.takumi,title_Getting+started,description_~R2V0IGNyZWRlbnRpYWxzLCBtYWtlIHlvdXIgZmlyc3QgUGFydG5lciBBUEkgcmVxdWVzdCBhbmQgZXhwbG9yZSB0aGUgZGVtbyBkYXRhLg,props_eyJ0aGVtZSI6eyJtb2RlIjoibGlnaHQiLCJjb2xvcnMiOnsicHJpbWFyeSI6IiMwRTJBMUYifX19,p_Ii9nZXR0aW5nLXN0YXJ0ZWQi,s_IJIIWuQdzqmUwX2r.png"
---

# Getting started

Get your credentials, make your first request and book against demo data, all in about ten minutes.

The API is in read-only mode

Every `GET` endpoint is live. `POST`, `PATCH` and `DELETE` operations return `403 writes-disabled` until writes are switched on. They're fully documented, so you can build against them now.

## [1\. Get your credentials](#_1-get-your-credentials)

Kong Gateway sits in front of the Partner API. It checks your API key, applies your contracted quotas and tells the API who you are.

1. Create your developer account

[Register](https://portal.konghotels.cloud/register) with your work email. Your partner manager approves new accounts.

2. Create an application

Go to [My apps](https://portal.konghotels.cloud/apps) and create an application for your integration, for example _Acme Travel – production_.

3. Request access to the Partner API

Open the [Partner API](https://portal.konghotels.cloud/apis) and request access for your application. Once approved, generate an API key.

Send the key in the `apikey` header on every request. Keep it on your server. Never ship it in a browser or mobile app.

## [2\. Make your first request](#_2-make-your-first-request)

| Environment  | Base URL                     | Authentication     |
| :----------- | :--------------------------- | :----------------- |
| Kong Gateway | https://api.konghotels.cloud | apikey: <your key> |

The API runs on seeded inventory, so this request returns live, all-in prices for both New York hotels:

cURL

JavaScript

Python

```bash
curl "https://api.konghotels.cloud/availability?destination=new-york&check_in=2026-12-04&check_out=2026-12-07&adults=2" \
  -H "apikey: $KONG_HOTELS_API_KEY"
```

```js
const params = new URLSearchParams({
  destination: 'new-york',
  check_in: '2026-12-04',
  check_out: '2026-12-07',
  adults: '2',
})

const res = await fetch(`https://api.konghotels.cloud/availability?${params}`, {
  headers: { apikey: process.env.KONG_HOTELS_API_KEY },
})
const { data } = await res.json()
```

```python
import os
import requests

res = requests.get(
    "https://api.konghotels.cloud/availability",
    params={"destination": "new-york", "check_in": "2026-12-04", "check_out": "2026-12-07", "adults": 2},
    headers={"apikey": os.environ["KONG_HOTELS_API_KEY"]},
)
data = res.json()["data"]
```

Each result is the cheapest sellable offer for one hotel. Follow `links.availability` to see every room type and rate plan, fully priced:

```json
{
  "property": { "code": "KTNYC", "name": "Kong Tower Manhattan", "brand": "kong-tower", "star_rating": 5, "city": "New York" },
  "currency": "USD",
  "offer_count": 16,
  "lowest_offer": {
    "room_type_code": "TWRK",
    "room_type_name": "Tower King",
    "rate_plan_code": "ADV",
    "meal_plan": "room_only",
    "is_refundable": false,
    "average_nightly_rate": "358.33",
    "tax_total": "169.06",
    "total": "1244.06"
  },
  "links": {
    "availability": "https://api.konghotels.cloud/properties/KTNYC/availability?check_in=2026-12-04&check_out=2026-12-07&adults=2"
  }
}
```

Amounts are decimal strings in the hotel's currency. Read [Money, dates & times](https://portal.konghotels.cloud/guides/money-dates-times) before you display them.

## [3\. Your partner identity](#_3-your-partner-identity)

After authenticating you, the gateway forwards your consumer identity in `X-Consumer-Custom-ID`, `X-Consumer-ID` or `X-Consumer-Username` (the first non-empty one wins). That identity is your **partner ID**.

Quotes, holds, reservations, group requests and webhooks are private to the partner that created them. Asking for another partner's resource returns `404`, not `403`.

## [4\. Explore the demo reservations](#_4-explore-the-demo-reservations)

The `demo-partner` identity owns six seeded reservations, `KH4DEMO01` to `KH4DEMO06`, so you can try the reservation, folio and cancellation-quote endpoints while writes are off:

```bash
curl "https://api.konghotels.cloud/reservations?per_page=6" -H "apikey: $KONG_HOTELS_API_KEY"
curl "https://api.konghotels.cloud/reservations/KH4DEMO01/folio" -H "apikey: $KONG_HOTELS_API_KEY"
```

See [Test data](https://portal.konghotels.cloud/guides/test-data) for property codes, Kong Rewards members and promotion codes.

## [Next steps](#next-steps)

[

### Booking flow

From search to confirmation number, and what to do after.





](https://portal.konghotels.cloud/guides/booking-flow)[

### Staying in sync

Use the change feed or signed webhooks instead of re-crawling.





](https://portal.konghotels.cloud/guides/staying-in-sync)[

### Errors

RFC 9457 problem details, and which `type` to switch on.





](https://portal.konghotels.cloud/guides/errors)[

### API reference

All 50 operations, with schemas and a Try it console.





](https://portal.konghotels.cloud/apis)