Task Boards

Retrieve the list of task boards in your account. Task boards are the top-level containers for organizing tasks.

Endpoint

Method	Endpoint	Description
GET	/tasks/v1/taskboards	Get all task boards

Example Request

curl --request GET \
  --url https://api.connecteam.com/tasks/v1/taskboards \
  --header 'X-API-KEY: YOUR_API_KEY'

Response

{
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "data": {
    "taskBoards": [
      {
        "id": 12345,
        "name": "Daily Operations",
        "isArchived": false
      },
      {
        "id": 12346,
        "name": "Maintenance Tasks",
        "isArchived": false
      },
      {
        "id": 12347,
        "name": "Old Projects",
        "isArchived": true
      }
    ]
  }
}

Response Fields

Field	Type	Description
id	integer	Unique task board identifier
name	string	Display name of the task board
isArchived	boolean	Whether the board is archived

📝
Archived Boards
Archived task boards are returned in the list. You can still read tasks from archived boards, but creating new tasks may be restricted.

Common Use Cases

Get Active Task Boards

const response = await fetch('https://api.connecteam.com/tasks/v1/taskboards', {
  headers: { 'X-API-KEY': 'YOUR_API_KEY' }
});

const data = await response.json();
const activeBoards = data.data.taskBoards.filter(board => !board.isArchived);

console.log('Active task boards:', activeBoards);

Build Board Mapping

// Create a mapping of board names to IDs
const boardMap = {};
data.data.taskBoards.forEach(board => {
  boardMap[board.name] = board.id;
});

// Use in subsequent API calls
const dailyOpsId = boardMap['Daily Operations'];
await fetch(`https://api.connecteam.com/tasks/v1/taskboards/${dailyOpsId}/tasks`, {
  headers: { 'X-API-KEY': 'YOUR_API_KEY' }
});

API Reference