---
title: "Get a property"
url: "https://portal.konghotels.cloud/apis/kong-hotels-partner-api-1/versions/23cc133a-2f87-4d55-9490-0b8b2bb7dd78/operations/getProperty"
---

> Full API specification: https://portal.konghotels.cloud/apis/kong-hotels-partner-api-1/versions/23cc133a-2f87-4d55-9490-0b8b2bb7dd78.md

# Get a property

`GET` `/properties/{propertyCode}`

Operation ID: `getProperty`

Full content for one property, including room types, amenities and review score.

## Path parameters

- `propertyCode` (string, required) - Property code (case-insensitive).

## Responses

- `200` - The property.
- `404` - Not found, or owned by another partner.
- `429` - Rate limit exceeded.

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Kong Hotels Partner API
  version: 1.0.0
servers:
  - url: https://api.konghotels.cloud
    description: Kong Gateway
paths:
  /properties/{propertyCode}:
    get:
      tags:
        - Properties
      operationId: getProperty
      summary: Get a property
      description: Full content for one property, including room types, amenities and
        review score.
      parameters:
        - $ref: "#/components/parameters/PropertyCode"
      responses:
        "200":
          description: The property.
          headers:
            X-Request-ID:
              $ref: "#/components/headers/RequestId"
            X-RateLimit-Limit:
              $ref: "#/components/headers/RateLimitLimit"
            X-RateLimit-Remaining:
              $ref: "#/components/headers/RateLimitRemaining"
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: "#/components/schemas/Property"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/RateLimited"
security:
  - KongKeyAuth: []
  - KongConsumer: []
components:
  parameters:
    PropertyCode:
      name: propertyCode
      in: path
      required: true
      description: Property code (case-insensitive).
      schema:
        type: string
        examples:
          - KTNYC
  headers:
    RequestId:
      description: Correlation ID for support.
      schema:
        type: string
    RateLimitLimit:
      description: Requests allowed per minute in this bucket.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in the current window.
      schema:
        type: integer
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
  schemas:
    Property:
      type: object
      properties:
        code:
          type: string
          examples:
            - KTNYC
        name:
          type: string
          examples:
            - Kong Tower Manhattan
        brand:
          type: object
          properties:
            code:
              $ref: "#/components/schemas/BrandCode"
            name:
              type: string
              examples:
                - Kong Tower
            segment:
              type: string
              examples:
                - upper_upscale
        star_rating:
          type: integer
          minimum: 1
          maximum: 5
        destination_code:
          type: string
        description:
          type: string
        address:
          type: object
          properties:
            line1:
              type: string
            line2:
              type:
                - string
                - "null"
            city:
              type: string
            state_province:
              type:
                - string
                - "null"
            postal_code:
              type:
                - string
                - "null"
            country_code:
              type: string
        location:
          $ref: "#/components/schemas/Location"
        distance_km:
          type: number
          description: Only when searching by coordinates.
        contact:
          type: object
          properties:
            phone:
              type: string
            email:
              type: string
              format: email
        currency:
          type: string
          examples:
            - USD
        timezone:
          type: string
        check_in_time:
          type: string
          examples:
            - 16:00
        check_out_time:
          type: string
          examples:
            - 11:00
        review_score:
          type: number
          description: Average overall rating
          1–10.: null
        review_count:
          type: integer
        amenities:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                examples:
                  - rooftop_terrace
              name:
                type: string
              category:
                type: string
        hero_photo:
          $ref: "#/components/schemas/Photo"
        room_types:
          type: array
          description: Only on the property detail endpoint.
          items:
            $ref: "#/components/schemas/RoomType"
        links:
          type: object
          properties:
            self:
              type: string
              format: uri
            room_types:
              type: string
              format: uri
            availability:
              type: string
              format: uri
    BrandCode:
      type: string
      enum:
        - kong-summit
        - kong-tower
        - kong-lagoon
        - kong-canopy
        - kong-basecamp
    Location:
      type: object
      properties:
        latitude:
          type: number
        longitude:
          type: number
    Photo:
      type: object
      properties:
        url:
          type: string
          format: uri
        caption:
          type: string
        category:
          type: string
          examples:
            - exterior
            - lobby
            - room
            - pool
        room_type_code:
          type:
            - string
            - "null"
        width:
          type: integer
        height:
          type: integer
    RoomType:
      type: object
      properties:
        code:
          type: string
          examples:
            - TWRK
        name:
          type: string
          examples:
            - Tower King
        description:
          type: string
        occupancy:
          type: object
          description: Limits per room. Every room needs at least one adult.
          properties:
            max_occupancy:
              type: integer
            max_adults:
              type: integer
            max_children:
              type: integer
        bed_configuration:
          type: string
          examples:
            - 1 king
        size_sqm:
          type: integer
        view:
          type:
            - string
            - "null"
        is_accessible:
          type: boolean
        is_smoking:
          type: boolean
        amenities:
          type: array
          items:
            type: string
        photos:
          type: array
          items:
            $ref: "#/components/schemas/Photo"
    Problem:
      type: object
      description: RFC 9457 problem details. Extra members (e.g. `available_units`,
        `restrictions`, `reasons`) may be present.
      required:
        - type
        - title
        - status
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        instance:
          type: string
        request_id:
          type: string
      additionalProperties: true
  responses:
    NotFound:
      description: Not found, or owned by another partner.
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/Problem"
          example:
            type: https://developers.konghotels.example/problems/not-found
            title: Resource not found
            status: 404
            detail: Property not found.
            instance: /properties/KXXXX
            request_id: 9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d
    RateLimited:
      description: Rate limit exceeded.
      headers:
        Retry-After:
          $ref: "#/components/headers/RetryAfter"
        X-RateLimit-Limit:
          $ref: "#/components/headers/RateLimitLimit"
        X-RateLimit-Remaining:
          $ref: "#/components/headers/RateLimitRemaining"
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/Problem"
          example:
            type: https://developers.konghotels.example/problems/rate-limited
            title: Too many requests
            status: 429
            detail: Rate limit exceeded. Retry after the number of seconds in the
              Retry-After header.
            instance: /availability
            request_id: 5b4a3f2e-1d0c-4b9a-8f7e-6d5c4b3a2f1e
  securitySchemes:
    KongKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: Your API key, validated by Kong Gateway. The header name depends on
        the gateway's key-auth configuration.
    KongConsumer:
      type: apiKey
      in: header
      name: X-Consumer-ID
      description: "**Local development only.** Simulates the consumer identity Kong
        Gateway injects after authentication."
```
