Ir al contenido principal
Boards

Get a board by ID

Retrieves a single board by its unique identifier.

GET
/v2/boards/{id}

Returns the full board object including all access controls, feature toggles, and localization settings.

Authorizationstringheaderobligatorio

API key as Bearer token. Use: Authorization: Bearer sk_...

idstringobligatorio

Board unique identifier

Ejemplo: 507f1f77bcf86cd799439011
Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Opciones disponibles: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Ejemplo: 2026-08-19.orbit

Respuesta

application/json

Success

accessobjectobligatorio
createdAtstringobligatorio

ISO 8601 timestamp when created

Ejemplo: 2023-12-12T00:00:00.000Z
customFieldsstring[]obligatorio

Custom field IDs attached to this board

featuresobjectobligatorio
iconobject | nullobligatorio

The board's icon. Can be one of three types:

  • emoji: A single emoji character (e.g., 💡, 🚀, ⭐)
  • icon: A predefined icon from the built-in library (e.g., lightbulb, bug, star)
  • url: A custom image URL (HTTPS required)

Can be null if no icon is set.

An emoji character as the board icon

idstringobligatorio

Unique identifier

Ejemplo: 507f1f77bcf86cd799439011
localizationobjectobligatorio
namestringobligatorio

Display name in organization's default locale

Ejemplo: Feature Requests
objectenum<string>obligatorio

Object type identifier

Opciones disponibles: board
Ejemplo: board
postDefaultsobjectobligatorio