Skip to main content
GET
/
boards
cURL
curl --request GET \
  --url https://api.dock.us/{version}/boards \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "boards": [
      {
        "id": "RiHO4e0Ju3DS",
        "updatedAt": "2021-01-01T00:00:00.000Z",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "object": "board",
        "url": "https://api.dock.us/v1/boards/RiHO4e0Ju3DS",
        "title": "Sales",
        "appearance": "greyExtraLight",
        "icon": "🚀",
        "description": "Sales leads",
        "tags": [
          {
            "id": "RiHO4e0Ju3DS",
            "updatedAt": "2021-01-01T00:00:00.000Z",
            "createdAt": "2021-01-01T00:00:00.000Z",
            "object": "tag",
            "url": "https://api.dock.us/v1/tags/RiHO4e0Ju3DS",
            "title": "Logo"
          }
        ]
      }
    ],
    "pageInfo": {
      "page": 1,
      "pages": 10,
      "total": 100,
      "pageTotal": 10,
      "hasNextPage": true,
      "hasPrevPage": false
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
properties
enum<string>[]

Select the board properties that should be returned

Available options:
title,
appearance,
icon,
updatedAt,
description,
createdAt,
tags.title,
tags.createdAt,
tags.updatedAt
​
limit
integer

Number of results to return

​
page
integer

Page number

Response

List of boards

​
data
object