GET/boards/:boardId/lists

Get Board Lists

Returns all lists within a specific board, ordered by their position. Use this to find list IDs when creating tasks.

Overview

Lists are the columns within a board that organize tasks into categories or stages. Common examples include 'To Do', 'In Progress', and 'Done' - but teams can create any lists they need. Each list has a unique ID that you need when creating tasks, because every task must belong to exactly one list. Lists are returned in their display order (left to right as shown in StrikeOff), and each includes a count of how many active (non-archived) tasks it contains. The customer field allows lists to be associated with specific clients when using StrikeOff for client work.

When to Use This

  • Finding the correct list ID to use when creating a new task via the API
  • Understanding how a board is structured before syncing tasks
  • Building a workflow that routes tasks to specific lists based on their type or status
  • Displaying list names and task counts in your integration UI
  • Mapping your external system categories to StrikeOff lists

Path Parameters

ParameterTypeDescription
boardIdrequiredstringThe unique identifier of the board

Request Example

cURL
curl -X GET "https://strikeoffapp.com/api/external/v1/boards/clxxx123/lists" \
  -H "Authorization: Bearer sk_live_your_api_key"

Response

JSON
{
  "success": true,
  "data": {
    "board": {
      "id": "clxxx123...",
      "name": "Development"
    },
    "lists": [
      {
        "id": "cllist001...",
        "name": "Backlog",
        "order": 0,
        "customer": null,
        "createdAt": "2024-01-15T10:00:00Z",
        "updatedAt": "2024-01-15T10:00:00Z",
        "taskCount": 24
      },
      {
        "id": "cllist002...",
        "name": "In Progress",
        "order": 1,
        "customer": null,
        "createdAt": "2024-01-15T10:00:00Z",
        "updatedAt": "2024-01-15T10:00:00Z",
        "taskCount": 8
      },
      {
        "id": "cllist003...",
        "name": "Done",
        "order": 2,
        "customer": null,
        "createdAt": "2024-01-15T10:00:00Z",
        "updatedAt": "2024-01-15T10:00:00Z",
        "taskCount": 156
      }
    ]
  }
}

Notes

  • Lists are returned in order (by their position on the board).
  • The customer field is used for client-specific lists (may be null).
  • Use the list ID from this response when creating new tasks.