> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gomarketbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Read a hold — its status, its heldUntil, and the supplier time it claims

> Returns the reservation as it stands. status is HELD (live), CONVERTED (already booked — a repeated convert replays the same bookings), or RELEASED. A hold past its heldUntil may still read as HELD: expiry is lazy, so compare heldUntil against now rather than trusting status alone.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/projects/{projectId}/holds/{reservationId}
openapi: 3.0.0
info:
  title: MarketBox 2.0 Open API
  version: 1.0.0
  description: >-
    The MarketBox public API for building booking experiences. Core model:
    create an order, then draw its order items down into bookings. Single
    bookings reference an order item per service line; package bookings draw one
    PACKAGE item down across N sessions. To schedule a package, build a slate
    (POST /availability/package-slate) and book it by slateId (POST
    /orders/{orderId}/package-bookings). See the guides for end-to-end
    walkthroughs.
  contact:
    name: MarketBox support
servers:
  - url: https://apiv2.gomarketbox.com
    description: MarketBox Open API
security:
  - ApiKeyAuth: []
paths:
  /v1/projects/{projectId}/holds/{reservationId}:
    get:
      tags:
        - Holds
      summary: Read a hold — its status, its heldUntil, and the supplier time it claims
      description: >-
        Returns the reservation as it stands. status is HELD (live), CONVERTED
        (already booked — a repeated convert replays the same bookings), or
        RELEASED. A hold past its heldUntil may still read as HELD: expiry is
        lazy, so compare heldUntil against now rather than trusting status
        alone.
      parameters:
        - schema:
            type: string
            minLength: 1
            description: The project the hold belongs to.
            example: prj_01kv60qgnef2kt3pvqgwmkbzfr
          required: true
          description: The project the hold belongs to.
          name: projectId
          in: path
        - schema:
            type: string
            minLength: 1
            description: The reservationId returned by POST /holds.
            example: resv_01kv8p20m1gnqvxl92xln6awk8
          required: true
          description: The reservationId returned by POST /holds.
          name: reservationId
          in: path
      responses:
        '200':
          description: The hold
          content:
            application/json:
              schema:
                type: object
                properties:
                  reservationId:
                    type: string
                    example: resv_01kv8p20m1gnqvxl92xln6awk8
                  status:
                    type: string
                    enum:
                      - HELD
                      - CONVERTED
                      - RELEASED
                  heldUntil:
                    type: string
                    format: date-time
                    description: >-
                      When the hold lapses. Expiry is LAZY — nothing runs at
                      this instant; the hold simply stops blocking. Convert
                      before this time.
                    example: '2026-07-10T12:05:00.000Z'
                  intervals:
                    type: array
                    items:
                      type: object
                      properties:
                        supplierId:
                          type: string
                        startUtc:
                          type: string
                          format: date-time
                        endUtc:
                          type: string
                          format: date-time
                        bookingTz:
                          type: string
                          nullable: true
                          description: >-
                            IANA timezone carried onto the hold; the booking's
                            local times are derived from it at convert.
                          example: America/Toronto
                        locationType:
                          type: string
                          nullable: true
                          enum:
                            - PHYSICAL
                            - VIRTUAL
                            - TRAVEL_ZONE
                            - null
                          description: >-
                            VIRTUAL, PHYSICAL or TRAVEL_ZONE. Null only on a
                            hold placed before location carry-through existed.
                          example: TRAVEL_ZONE
                        locationId:
                          type: string
                          nullable: true
                          description: >-
                            The Location id (PHYSICAL) or supplierTravelZoneId
                            (TRAVEL_ZONE). Null for VIRTUAL.
                          example: stz_01kv60qgs4e4nbjhzradnqtj0h
                        latitude:
                          type: number
                          nullable: true
                          example: 43.6532
                        longitude:
                          type: number
                          nullable: true
                          example: -79.3832
                        address:
                          type: object
                          nullable: true
                          properties:
                            addressOneLine:
                              type: string
                              minLength: 1
                              description: >-
                                The whole address on one line, as a person would
                                write it.
                              example: 10 Main St, Toronto, ON M5V 1A1, Canada
                            streetNumber:
                              type: string
                              minLength: 1
                              description: The street number.
                              example: '10'
                            streetName:
                              type: string
                              minLength: 1
                              description: The street name.
                              example: Main St
                            city:
                              type: string
                              minLength: 1
                              description: The city or town.
                              example: Toronto
                            state:
                              type: string
                              minLength: 1
                              description: >-
                                The state, province or region; an ISO 3166-2
                                code when one matches.
                              example: 'ON'
                            country:
                              type: string
                              minLength: 1
                              description: >-
                                The country; ISO 3166-1 alpha-2, alpha-3 or the
                                English name.
                              example: CA
                            zipCode:
                              type: string
                              minLength: 1
                              description: The postal or ZIP code, in any national format.
                              example: M5V 1A1
                            unitNumber:
                              type: string
                              nullable: true
                              description: The unit, suite or apartment, if any.
                              example: 4B
                          required:
                            - addressOneLine
                            - streetNumber
                            - streetName
                            - city
                            - state
                            - country
                            - zipCode
                          description: >-
                            The structured client address held for a TRAVEL_ZONE
                            session.
                      required:
                        - supplierId
                        - startUtc
                        - endUtc
                required:
                  - reservationId
                  - status
                  - heldUntil
                  - intervals
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: API key cannot access this project
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: No such reservation in this project
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
components:
  schemas:
    ErrorMessage:
      type: object
      properties:
        code:
          type: string
          description: Stable machine-readable error code, e.g. NOT_FOUND.
        message:
          type: string
          description: Human-readable description of what went wrong.
        statusCode:
          type: integer
          description: The HTTP status code of this response.
        requestId:
          type: string
          description: >-
            The id of this request, also returned as the X-Request-Id header.
            Quote it in a support ticket.
      required:
        - code
        - message
        - statusCode
        - requestId
      example:
        code: NOT_FOUND
        message: Booking not found
        statusCode: 404
        requestId: a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key minted in the MarketBox dashboard. Scope is restricted to the
        projects you select at creation time. Every route needs the key's
        standard API access (`*`) except `POST /v1/projects/{projectId}/events`,
        which needs `events:write`; a key without `*` is refused with 403
        `CAPABILITY_NOT_GRANTED`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.