Skip to main content
Planview Customer Success Center

List all boards

GET /io/board

List all boards.

Query Params

Param Type Usage Default
offset integer Set the "start row" number of the first card to be returned. 0
limit integer Set the number of cards to be returned. 200
search string Filter boards that match the title provided.
invert boolean Return boards in reverse alphabetical order by title false
minimumAccess enumeration Return boards where users have this role or greater. Possible roles: none: 0, reader: 1, user: 2, manager: 3 administrator: 4
archived boolean Include archived boards in results. note: requires organization administrator privileges false

Example Request

List all boards

curl -X GET \
  https://myaccount.leankit.com/io/board' \
  -H 'Authorization: Basic base64encodedauth' \

List boards that have "sample" in the title where the user's access is "manager" or greater

curl -X GET \
  https://myaccount.leankit.com/io/board?search=sample&minimumAccess=3' \
  -H 'Authorization: Basic base64encodedauth' \

Example Successful Response

200 Success

{
    "pageMeta": {
        "totalRecords": 2,
        "offset": 0,
        "limit": 25,
        "startRow": 1,
        "endRow": 2
    },
    "boards": [
        {
            "id": "621306392",
            "title": "sample board",
            "description": null,
            "boardRoleId": 4,
            "isWelcome": false,
            "boardRole": "boardAdministrator"
        },
        {
            "id": "814278941",
            "title": "board number 2",
            "description": "sample board description",
            "boardRoleId": 4,
            "isWelcome": false,
            "boardRole": "boardAdministrator"
        }
    ]
}

Response Properties

Property Type Note
id string The board id
title string The board title
description string The board description
boardRoleId integer The board role id
isWelcome boolean Indicates if the board is a welcome board
boardRole string The string representation of the board role



Updated 2020-01-22 @ 12:01 PM