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

# Get a board by public ID



## OpenAPI

````yaml https://opscape.com/api/v1/openapi.json get /boards/{boardPublicId}
openapi: 3.0.0
info:
  title: Kan API
  description: OpenAPI compliant REST API
  version: 1.0.0
  contact: {}
servers: []
security: []
tags: []
paths:
  /boards/{boardPublicId}:
    get:
      tags:
        - Boards
      summary: Get a board by public ID
      operationId: getBoard
      parameters:
        - name: boardPublicId
          required: true
          in: path
          schema:
            type: string
        - name: members
          required: false
          in: query
          schema:
            type: array
            items:
              type: string
              minLength: 12
        - name: labels
          required: false
          in: query
          schema:
            type: array
            items:
              type: string
              minLength: 12
        - name: lists
          required: false
          in: query
          schema:
            type: array
            items:
              type: string
              minLength: 12
        - name: dueDateFilters
          required: false
          in: query
          schema:
            type: array
            items:
              type: string
              enum:
                - overdue
                - today
                - tomorrow
                - next-week
                - next-month
                - no-due-date
        - name: type
          required: false
          in: query
          schema:
            type: string
            enum:
              - regular
              - template
        - name: cardView
          required: false
          in: query
          schema:
            default: full
            type: string
            enum:
              - full
              - summary
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoardDetailDto_Output'
      security:
        - bearer: []
components:
  schemas:
    BoardDetailDto_Output:
      type: object
      properties:
        publicId:
          type: string
        name:
          type: string
        slug:
          type: string
        visibility:
          type: string
          enum:
            - private
            - public
        isArchived:
          type: boolean
        favorite:
          type: boolean
        assignedMemberPublicIds:
          type: array
          items:
            type: string
          description: Members assigned to at least one card on the board.
        workspace:
          type: object
          properties:
            publicId:
              type: string
            cardPrefix:
              type: string
            members:
              type: array
              items:
                type: object
                properties:
                  publicId:
                    type: string
                  email:
                    type: string
                  status:
                    type: string
                    enum:
                      - invited
                      - active
                      - removed
                      - paused
                  user:
                    type: object
                    properties:
                      id:
                        type: string
                        nullable: true
                      name:
                        type: string
                        nullable: true
                      email:
                        type: string
                      image:
                        type: string
                        nullable: true
                    required:
                      - id
                      - name
                      - email
                      - image
                    additionalProperties: false
                    nullable: true
                required:
                  - publicId
                  - email
                  - status
                  - user
                additionalProperties: false
          required:
            - publicId
            - cardPrefix
            - members
          additionalProperties: false
        labels:
          type: array
          items:
            type: object
            properties:
              publicId:
                type: string
              name:
                type: string
              colourCode:
                type: string
                nullable: true
            required:
              - publicId
              - name
              - colourCode
            additionalProperties: false
        lists:
          type: array
          items:
            type: object
            properties:
              publicId:
                type: string
              name:
                type: string
              index:
                type: number
              cards:
                type: array
                items:
                  type: object
                  properties:
                    publicId:
                      type: string
                    title:
                      type: string
                    description:
                      type: string
                      nullable: true
                    index:
                      type: number
                    cardNumber:
                      type: number
                      nullable: true
                    dueDate:
                      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))$
                      nullable: true
                    labels:
                      type: array
                      items:
                        type: object
                        properties:
                          publicId:
                            type: string
                          name:
                            type: string
                          colourCode:
                            type: string
                            nullable: true
                        required:
                          - publicId
                          - name
                          - colourCode
                        additionalProperties: false
                    members:
                      type: array
                      items:
                        type: object
                        properties:
                          publicId:
                            type: string
                          email:
                            type: string
                          status:
                            type: string
                            enum:
                              - invited
                              - active
                              - removed
                              - paused
                          user:
                            type: object
                            properties:
                              name:
                                type: string
                                nullable: true
                              email:
                                type: string
                              image:
                                type: string
                                nullable: true
                            required:
                              - name
                              - email
                              - image
                            additionalProperties: false
                            nullable: true
                        required:
                          - publicId
                          - email
                          - status
                          - user
                        additionalProperties: false
                    attachments:
                      type: array
                      items:
                        type: object
                        properties:
                          publicId:
                            type: string
                        required:
                          - publicId
                        additionalProperties: false
                    checklists:
                      type: array
                      items:
                        type: object
                        properties:
                          publicId:
                            type: string
                          name:
                            type: string
                          index:
                            type: number
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                publicId:
                                  type: string
                                title:
                                  type: string
                                completed:
                                  type: boolean
                                index:
                                  type: number
                              required:
                                - publicId
                                - title
                                - completed
                                - index
                              additionalProperties: false
                        required:
                          - publicId
                          - name
                          - index
                          - items
                        additionalProperties: false
                    comments:
                      type: array
                      items:
                        type: object
                        properties:
                          publicId:
                            type: string
                        required:
                          - publicId
                        additionalProperties: false
                    summary:
                      type: object
                      properties:
                        hasDescription:
                          type: boolean
                        attachmentCount:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        hasComments:
                          type: boolean
                        checklistItemCount:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        completedChecklistItemCount:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                      required:
                        - hasDescription
                        - attachmentCount
                        - hasComments
                        - checklistItemCount
                        - completedChecklistItemCount
                      additionalProperties: false
                  required:
                    - publicId
                    - title
                    - description
                    - index
                    - cardNumber
                    - dueDate
                    - labels
                    - members
                    - attachments
                    - checklists
                    - comments
                  additionalProperties: false
            required:
              - publicId
              - name
              - index
              - cards
            additionalProperties: false
        allLists:
          type: array
          items:
            type: object
            properties:
              publicId:
                type: string
              name:
                type: string
            required:
              - publicId
              - name
            additionalProperties: false
      required:
        - publicId
        - name
        - slug
        - visibility
        - isArchived
        - favorite
        - assignedMemberPublicIds
        - workspace
        - labels
        - lists
        - allLists
      additionalProperties: false
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````

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