---
title: "Get the whole board"
url: "https://dev-portal-nov11.movespot.fyi/apis/tic-tac-toe-1-0-0/versions/1756fa82-c2da-4b9a-81c8-4b53c7dbf566/operations/get-board"
---

> Full API specification: https://dev-portal-nov11.movespot.fyi/apis/tic-tac-toe-1-0-0/versions/1756fa82-c2da-4b9a-81c8-4b53c7dbf566.md

# Get the whole board

`GET` `/board`

Operation ID: `get-board`

Retrieves the current state of the board and the winner.

## Responses

- `200` - OK

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Tic Tac Toe
  version: 1.0.0
paths:
  /board:
    get:
      summary: Get the whole board
      description: Retrieves the current state of the board and the winner.
      tags:
        - Gameplay
      operationId: get-board
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/status"
      security:
        - defaultApiKey: []
        - app2AppOauth:
            - board:read
security:
  - defaultApiKey: []
  - app2AppOauth:
      - board:read
components:
  schemas:
    status:
      type: object
      properties:
        winner:
          $ref: "#/components/schemas/winner"
        board:
          $ref: "#/components/schemas/board"
    winner:
      type: string
      enum:
        - .
        - X
        - O
      description: Winner of the game. `.` means nobody has won yet.
      example: .
    board:
      type: array
      maxItems: 3
      minItems: 3
      items:
        type: array
        maxItems: 3
        minItems: 3
        items:
          $ref: "#/components/schemas/mark"
    mark:
      type: string
      enum:
        - .
        - X
        - O
      description: Possible values for a board square. `.` means empty square.
      example: .
  securitySchemes:
    defaultApiKey:
      description: API key provided in console
      type: apiKey
      name: api-key
      in: header
    app2AppOauth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://learn.openapis.org/oauth/2.0/token
          scopes:
            board:read: Read the board
```
