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

# Get the published floor plan

> The latest PUBLISHED plan. Table `id` is the stable UUID every other endpoint accepts (store it as your `pos_table_id`). Labels are display-only and renamable; never key on them.



## OpenAPI

````yaml /api-reference/openapi.json get /api/provider/v1/floorplan
openapi: 3.1.0
info:
  title: NowOS Reservations Provider API
  version: 1.0.0
  description: >-
    Integration surface for reservation providers (EatNow is the reference
    implementation). Read the published floor plan, write reservations keyed by
    your own ids, push a one-shot floor plan import, and consume signed webhooks
    for table lifecycle and spend. Every error body is `{ "error": { "code",
    "message", "occupiedBy" } }` — branch on `code` only.
servers:
  - url: https://api.now-os.app
security:
  - providerApiKey: []
paths:
  /api/provider/v1/floorplan:
    get:
      summary: Get the published floor plan
      description: >-
        The latest PUBLISHED plan. Table `id` is the stable UUID every other
        endpoint accepts (store it as your `pos_table_id`). Labels are
        display-only and renamable; never key on them.
      operationId: getFloorplan
      responses:
        '200':
          description: The published plan.
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  version:
                    type: integer
                    exclusiveMinimum: 0
                    maximum: 2147483647
                  publishedAt:
                    type: string
                    format: date-time
                    pattern: >-
                      ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                  rooms:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                        name:
                          type: string
                          minLength: 1
                          maxLength: 60
                        order:
                          type: integer
                          minimum: 0
                          maximum: 2147483647
                        tables:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                minLength: 1
                              label:
                                type: string
                                minLength: 1
                                maxLength: 12
                              shape:
                                type: string
                                enum:
                                  - round
                                  - square
                                  - rectangle
                                  - bar
                              seatCount:
                                type: integer
                                exclusiveMinimum: 0
                                maximum: 2147483647
                              minCovers:
                                anyOf:
                                  - type: integer
                                    exclusiveMinimum: 0
                                    maximum: 2147483647
                                  - type: 'null'
                              maxCovers:
                                anyOf:
                                  - type: integer
                                    exclusiveMinimum: 0
                                    maximum: 2147483647
                                  - type: 'null'
                              active:
                                type: boolean
                              x:
                                type: number
                              'y':
                                type: number
                              rotation:
                                type: number
                            required:
                              - id
                              - label
                              - shape
                              - seatCount
                              - minCovers
                              - maxCovers
                              - active
                              - x
                              - 'y'
                              - rotation
                            additionalProperties: false
                      required:
                        - id
                        - name
                        - order
                        - tables
                      additionalProperties: false
                required:
                  - version
                  - publishedAt
                  - rooms
                additionalProperties: false
        '404':
          description: '`floorplan_not_published` — nothing published yet.'
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - unauthorized
                          - unknown_reservation
                          - duplicate_reservation
                          - unknown_table_id
                          - table_occupied
                          - floorplan_not_published
                          - draft_not_empty
                          - validation_failed
                      message:
                        type: string
                        minLength: 1
                      occupiedBy:
                        default: null
                        anyOf:
                          - type: object
                            properties:
                              orderId:
                                anyOf:
                                  - type: string
                                    minLength: 1
                                  - type: 'null'
                              reservationExternalId:
                                anyOf:
                                  - type: string
                                    minLength: 1
                                  - type: 'null'
                            required:
                              - orderId
                              - reservationExternalId
                            additionalProperties: false
                          - type: 'null'
                    required:
                      - code
                      - message
                      - occupiedBy
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
      security:
        - providerApiKey: []
components:
  securitySchemes:
    providerApiKey:
      type: http
      scheme: bearer
      description: >-
        Location-scoped API key (`nowos_sk_live_…`), issued at registration. The
        key identifies the location — URLs carry no location id.

````