API Reference
Status Check
Accounts
Workspaces
Workspace users
Workspace domains
Workspace pages
Workspace sections
Workspace plan tasks
Retrieve a board
Retrieve a board by ID
curl --request GET \
--url https://api.dock.so:4000/{version}/boards/{id} \
--header 'Authorization: Bearer <token>'
{
"data": {
"board": {
"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"
}
]
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Unique identifier
"RiHO4e0Ju3DS"
Query Parameters
Select the board properties that should be returned
title
, appearance
, icon
, updatedAt
, description
, createdAt
, tags.title
, tags.createdAt
, tags.updatedAt
Response
Id of the object
"RiHO4e0Ju3DS"
Last updated date
"2021-01-01T00:00:00.000Z"
Created at date
"2021-01-01T00:00:00.000Z"
Type of the object
board
"board"
URL to the resource
"https://api.dock.us/v1/boards/RiHO4e0Ju3DS"
Title of the board
"Sales"
Appearance of the board
greyExtraLight
, mandy
, saffron
, conifer
, pastelGreen
, downy
, malibu
, royalBlue
, mediumPurple
, brilliantRose
"greyExtraLight"
Icon of the board
"🚀"
Description of the board
"Sales leads"
Tags of the board
Id of the object
"RiHO4e0Ju3DS"
Last updated date
"2021-01-01T00:00:00.000Z"
Created at date
"2021-01-01T00:00:00.000Z"
Type of the object
tag
"tag"
URL to the resource
"https://api.dock.us/v1/tags/RiHO4e0Ju3DS"
Title of the tag
"Logo"
curl --request GET \
--url https://api.dock.so:4000/{version}/boards/{id} \
--header 'Authorization: Bearer <token>'
{
"data": {
"board": {
"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"
}
]
}
}
}