Basecamp · Schema

DockItem

A tool available on a project's dock

CollaborationProject ManagementRESTSaaSTeam Communication

Properties

Name Type Description
id integer Dock item ID
title string Display title of the tool
name string Internal name of the tool (e.g., message_board, todoset)
enabled boolean Whether this tool is enabled on the project
position integer Display position of the tool in the dock
url string API URL for this tool's resource
app_url string Web URL for this tool's resource
View JSON Schema on GitHub

JSON Schema

dockitem-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/basecamp/json-schema/dockitem-schema.json",
  "title": "DockItem",
  "type": "object",
  "description": "A tool available on a project's dock",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Dock item ID"
    },
    "title": {
      "type": "string",
      "description": "Display title of the tool"
    },
    "name": {
      "type": "string",
      "description": "Internal name of the tool (e.g., message_board, todoset)"
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether this tool is enabled on the project"
    },
    "position": {
      "type": "integer",
      "description": "Display position of the tool in the dock",
      "nullable": true
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "API URL for this tool's resource"
    },
    "app_url": {
      "type": "string",
      "format": "uri",
      "description": "Web URL for this tool's resource"
    }
  }
}