---
updatedAt: 2025-05-19T14:05:15.000Z
agentTools:
  siteIndex: https://developers.klaxoon.com/llms.txt
  projectIndex: https://developers.klaxoon.com/klaxoon/llms.txt
---

# List board colors

### Required scope

[board:read](/docs/scopes)

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "contact": {
      "email": "contact@klaxoon.com"
    },
    "description": "API Board",
    "title": "Board",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.klaxoon.com",
      "description": "First version of API"
    }
  ],
  "tags": [
    {
      "name": "Board Color"
    }
  ],
  "paths": {
    "/v1/boards/{boardId}/colors": {
      "get": {
        "operationId": "V1BoardColorGetCollection",
        "tags": [
          "Board Color"
        ],
        "summary": "List board colors",
        "parameters": [
          {
            "name": "boardId",
            "description": "Unique identifier for the board.",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "example": "7ab61497-6dfb-45b1-94e1-f1ba7def0c02"
            },
            "style": "simple"
          },
          {
            "name": "page",
            "description": "The collection page number",
            "required": false,
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "default": 1
            }
          },
          {
            "name": "perPage",
            "description": "The number of items per page",
            "required": false,
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 100,
              "default": 50
            }
          }
        ],
        "security": [
          {
            "oauth2": []
          }
        ],
        "responses": {
          "200": {
            "description": "Operation success",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Pagination"
                    },
                    {
                      "$ref": "#/components/schemas/BoardColorList"
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "default": {
            "$ref": "#/components/responses/Default"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "oauth2": {
        "flows": {},
        "type": "oauth2"
      }
    },
    "responses": {
      "BadRequest": {
        "description": "Bad Request",
        "content": {
          "application/problem+json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/Error"
                },
                {
                  "type": "object",
                  "properties": {
                    "title": {
                      "example": "Bad Request"
                    },
                    "detail": {
                      "example": "Expecting a string, got number."
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "Unauthorized": {
        "description": "The user is not authorized to access this resource",
        "content": {
          "application/problem+json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/Error"
                },
                {
                  "type": "object",
                  "properties": {
                    "title": {
                      "example": "No valid authentication provided."
                    },
                    "detail": {
                      "example": "The user is not authorized to access to this resource."
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "Forbidden": {
        "description": "The user does not have the required permissions to access this resource",
        "content": {
          "application/problem+json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/Error"
                },
                {
                  "type": "object",
                  "properties": {
                    "title": {
                      "example": "You do not have access to this resource."
                    },
                    "detail": {
                      "example": "You tried to access to a resource that does not belong to you"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "NotFound": {
        "description": "The resource does not exists.",
        "content": {
          "application/problem+json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/Error"
                },
                {
                  "type": "object",
                  "properties": {
                    "title": {
                      "example": "Not Found"
                    },
                    "detail": {
                      "example": ""
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "Default": {
        "description": "Operation in error",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    },
    "schemas": {
      "BoardColorProperties": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "readOnly": true
          },
          "label": {
            "description": "",
            "type": "string",
            "example": "My color",
            "maxLength": 80
          },
          "value": {
            "description": "Hexadecimal value",
            "type": "string",
            "pattern": "^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$",
            "example": "#ffe151"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          }
        }
      },
      "BoardColor": {
        "allOf": [
          {
            "$ref": "#/components/schemas/BoardColorProperties"
          }
        ],
        "required": [
          "id",
          "value"
        ]
      },
      "BoardColorList": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BoardColor"
            }
          }
        }
      },
      "Error": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "A URI reference [RFC3986] that identifies the\nproblem type.  This specification encourages that, when\ndereferenced, it provide human-readable documentation for the\nproblem type (e.g., using HTML [W3C.REC-html5-20141028]).  When\nthis member is not present, its value is assumed to be\n\"about:blank\".\n",
            "example": "about:blank"
          },
          "title": {
            "type": "string",
            "description": "A short, human-readable summary of the problem\ntype.  It SHOULD NOT change from occurrence to occurrence of the\nproblem, except for purposes of localization (e.g., using\nproactive content negotiation; see [RFC7231], Section 3.4).\n",
            "example": "Bad Request"
          },
          "detail": {
            "type": "string",
            "description": "A human-readable explanation specific to this\noccurrence of the problem.\n",
            "example": "Expecting a string, got number."
          },
          "instance": {
            "type": "string",
            "description": "A URI reference that identifies the specific\noccurrence of the problem.  It may or may not yield further\ninformation if dereferenced.\n",
            "example": "/138d9bea-4edf-4e9c-86f7-43672e42c5dc"
          }
        },
        "required": [
          "type",
          "title"
        ]
      },
      "Pagination": {
        "type": "object",
        "properties": {
          "self": {
            "type": "string",
            "example": "https://klaxoon.com/api/path?page=1&perPage=1"
          },
          "first": {
            "type": "string",
            "example": "https://klaxoon.com/api/path?page=1&perPage=1"
          },
          "prev": {
            "type": "string",
            "example": null,
            "nullable": true
          },
          "next": {
            "type": "string",
            "example": "https://klaxoon.com/api/path?page=2&perPage=2",
            "nullable": true
          },
          "total": {
            "type": "integer",
            "format": "int32",
            "example": 200,
            "minimum": 0
          }
        }
      }
    }
  }
}
```