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

# Reservation Statuses

> The reservation statuses a venue has enabled.

These ids are what [Update a Reservation](/platform/reservation/update-reservation) accepts as `status`, and their codes are what a reservation's `status` field carries.


## OpenAPI

````yaml platform/reservation/openapi.json GET /venue/{venueId}/reservation-statuses
openapi: 3.0.4
info:
  title: NowBookIt Reservation API
  description: >-
    REST API for venue availability and reservation lifecycle. Every endpoint is
    venue-scoped: `/api/reservations/venue/{venueId}/...`.
  version: v1
  contact:
    email: platform.integrations@nowbookit.com
servers:
  - url: https://platform.uat.nowbookit.com/api/reservations
    description: UAT
  - url: https://platform.nowbookit.com/api/reservations
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Availability
    description: What a venue can offer for a party size over a date range.
  - name: Reservations
    description: List, read, create, amend and cancel a venue's reservations.
  - name: Reference data
    description: A venue's own guest tags and reservation statuses.
paths:
  /venue/{venueId}/reservation-statuses:
    get:
      tags:
        - Reference data
      summary: List reservation statuses
      description: >-
        The reservation statuses a venue has enabled, sorted by the venue's own
        display order. Use it to turn the `status` code a reservation carries
        into something you can show a guest.


        Statuses are per-venue: each venue enables its own set and gives them
        its own names, order and visibility. Several statuses can share one
        `code` — `id` is what distinguishes them, so resolve codes against the
        full list rather than filtering it.
      operationId: getReservationStatuses
      parameters:
        - $ref: '#/components/parameters/VenueId'
      responses:
        '200':
          description: The venue's enabled statuses, in display order.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReservationStatus'
              example:
                - id: status_unconfirmed
                  code: U
                  name: Unconfirmed
                  statusType: unconfirmed
                  hide: false
                  order: 1
                - id: status_seated_main
                  code: S
                  name: Seated - Main
                  statusType: seated
                  hide: false
                  order: 5
        '400':
          $ref: '#/components/responses/ValidationFailed'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    VenueId:
      name: venueId
      in: path
      required: true
      description: The venue being addressed. Every endpoint on this API is venue-scoped.
      schema:
        type: string
        minLength: 1
        example: '6247'
  schemas:
    ReservationStatus:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: string
          description: >-
            The status's own id. Several statuses can share one `code`, so this
            is what distinguishes them.
          example: status_seated_main
        code:
          allOf:
            - $ref: '#/components/schemas/ReservationStatusCode'
          description: >-
            The same code a reservation's `status` carries — the join between
            the two.
        name:
          type: string
          example: Seated - Main
        statusType:
          type: string
          description: A finer-grained state than `code`.
          example: seated
        hide:
          type: boolean
          description: >-
            The venue keeps this status out of its own status picker. A
            reservation can still be in it.
        order:
          type: integer
          description: Venue-defined display order.
    ReservationStatusCode:
      type: string
      enum:
        - U
        - P$
        - C
        - X
        - NS
        - S
        - F
        - SP
        - TX
      description: >-
        The status code the reservation carries, joining onto the
        reservation-statuses endpoint's `code`. `U` unconfirmed, `P$` pending
        payment, `C` confirmed, `X` cancelled, `NS` cancelled no-show, `S`
        seated, `F` finished, `SP` standby pending, `TX` SMS sent or SMS failed.


        Several statuses can share one code, so treat `code` as a coarse
        grouping and `statusId` as the precise value. Venues can add statuses of
        their own, so read the venue's own set from the reservation-statuses
        endpoint rather than assuming this list is closed.
    ValidationErrorResponse:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          required:
            - errors
          properties:
            errors:
              type: object
              description: >-
                Field path to the messages for that field. A cross-field rule
                with no single field to blame is keyed `query`, `path` or
                `body`.
              additionalProperties:
                type: array
                items:
                  type: string
    ErrorResponse:
      type: object
      required:
        - code
        - message
        - requestId
      properties:
        code:
          type: string
          description: >-
            The error class, e.g. `ValidationError`, `NotFoundError`,
            `InternalError`.
          example: NotFoundError
        message:
          type: string
        requestId:
          type: string
          description: Quote this when reporting a problem.
  responses:
    ValidationFailed:
      description: >-
        The request failed validation. `errors` is keyed by field path —
        `query`, `path` or `body` for an issue with no single field to blame.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
          example:
            code: ValidationError
            message: Query parameters failed validation
            requestId: 0f1c9f2e-4b8a-4c1e-9d33-2a7f5b1c8e90
            errors:
              partySize:
                - partySize must be at least 1
              endDate:
                - endDate must be on or after startDate
    NotFound:
      description: >-
        The venue or reservation does not exist, or does not belong to the venue
        addressed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: NotFoundError
            message: 'Venue not found: 6247'
            requestId: 0f1c9f2e-4b8a-4c1e-9d33-2a7f5b1c8e90
    ServerError:
      description: An unexpected failure. Quote `requestId` when reporting one.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: InternalError
            message: Internal server error
            requestId: 0f1c9f2e-4b8a-4c1e-9d33-2a7f5b1c8e90
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        Your API key. See [Authorization](/platform/authorization) to create
        one.

````

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