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

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

# Get a hold

`GET` `/holds/{holdId}`

Operation ID: `getHold`

## Path parameters

- `holdId` (string, required)

## Responses

- `200` - The hold. `status` is `active`, `released`, `converted` or `expired`.
- `404` - Not found, or owned by another partner.

## 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:
  /holds/{holdId}:
    get:
      tags:
        - Quotes & Holds
      operationId: getHold
      summary: Get a hold
      parameters:
        - $ref: "#/components/parameters/HoldId"
      responses:
        "200":
          description: The hold. `status` is `active`, `released`, `converted` or `expired`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: "#/components/schemas/Hold"
        "404":
          $ref: "#/components/responses/NotFound"
security:
  - KongKeyAuth: []
  - KongConsumer: []
components:
  parameters:
    HoldId:
      name: holdId
      in: path
      required: true
      schema:
        type: string
        pattern: ^hld_
  schemas:
    Hold:
      type: object
      properties:
        id:
          type: string
          examples:
            - hld_01jbx4q2r8s7t6u5v4w3x2y1z0
        status:
          type: string
          enum:
            - active
            - released
            - converted
            - expired
        quote_id:
          type: string
        room_type_code:
          type: string
        check_in:
          type: string
          format: date
        check_out:
          type: string
          format: date
        rooms:
          type: integer
        expires_at:
          type: string
          format: date-time
        released_at:
          type:
            - string
            - "null"
          format: date-time
        created_at:
          type: string
          format: date-time
    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
  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."
```