Tasks API: List boards
Endpoint#
Section titled “Endpoint#”| Property | Value |
|---|---|
| Type | query |
| Method | GET |
| Path | /api/external/v1/tasks/list_boards |
| Handler | OperatelyWeb.Api.Tasks.ListBoards |
Authentication#
Section titled “Authentication#”- Requires a valid API token.
- Read-only and full-access tokens can execute this query.
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
space_id | id primitive (encoded as string) | Yes | No | - |
archive_status | task_board_archive_status enum (active, archived, all) | No | No | - |
Outputs#
Section titled “Outputs#”| Field | Type | Required | Nullable |
|---|---|---|---|
boards | array of task_board_summary object | Yes | No |
cURL Example#
Section titled “cURL Example#”Copied
curl --request GET \
--url "https://app.operately.com/api/external/v1/tasks/list_boards?archive_status=active&space_id=value" \
--header "Authorization: Bearer ${OPERATELY_API_TOKEN}"Response Example#
Section titled “Response Example#”{ "boards": [ { "__typename": "value", "archived_at": "2026-01-01T09:30:00Z", "id": "value", "is_default": true, "name": "value", "position": 123 } ]}