Get task workspace
GET
/v1/tasks/workspaceBuild a board-ready task workspace payload with stats, grouped lanes, calendar items, releases, sprints, and task details.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
None.
Query parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| projectId | query | string | No | Restrict the workspace to one project. Use `none` for tasks without a project. |
| q | query | string | No | Search query applied across tasks, sprints, and releases. |
| rangeStart | query | string | No | — |
| rangeEnd | query | string | No | — |
Body schema
This endpoint does not require a request body.
None.
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Task workspace payloadapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| workspace | object | No | — |
| workspace.generatedAt | string | No | — |
| workspace.stats | object | No | — |
| workspace.stats.total | integer | No | — |
| workspace.stats.backlog | integer | No | — |
| workspace.stats.todo | integer | No | — |
| workspace.stats.inProgress | integer | No | — |
| workspace.stats.blocked | integer | No | — |
| workspace.stats.inReview | integer | No | — |
| workspace.stats.done | integer | No | — |
| workspace.stats.canceled | integer | No | — |
| workspace.stats.scheduled | integer | No | — |
| workspace.stats.overdue | integer | No | — |
| workspace.stats.readyToStart | integer | No | — |
| workspace.stats.blockedByDependencies | integer | No | — |
| workspace.projectId | string | No | Project ID. |
| workspace.tasks | object[] | No | — |
| workspace.tasks[].id | string | No | Unique identifier. |
| workspace.tasks[].userId | string | No | User ID. |
| workspace.tasks[].organizationId | string | No | — |
| workspace.tasks[].createdByUserId | string | No | — |
| workspace.tasks[].creator | object | No | — |
| workspace.tasks[].creator.type | user | agent | Yes | — |
| workspace.tasks[].creator.userId | string | No | User ID. |
| workspace.tasks[].creator.agentId | string | No | Agent ID. |
| workspace.tasks[].creator.name | string | No | Human-readable name. |
| workspace.tasks[].creator.avatarUrl | string | No | — |
| workspace.tasks[].projectId | string | No | Project ID. |
| workspace.tasks[].releaseId | string | No | — |
| workspace.tasks[].title | string | No | Display title. |
| workspace.tasks[].description | string | No | Human-readable description. |
| workspace.tasks[].status | backlog | todo | in_progress | blocked | in_review | done | canceled | No | Current lifecycle status. |
| workspace.tasks[].priority | low | medium | high | urgent | No | — |
| workspace.tasks[].type | task | subtask | loop | No | — |
| workspace.tasks[].parentTaskId | string | No | — |
| workspace.tasks[].loop | object | No | — |
| workspace.tasks[].loop.schemaVersion | task_loop_v1 | No | — |
| workspace.tasks[].loop.enabled | boolean | No | — |
| workspace.tasks[].loop.goal | string | No | End goal the loop should reach. |
| workspace.tasks[].loop.endGoal | string | No | Alias for goal. |
| workspace.tasks[].loop.progressSignal | string | No | Observable signal that shows each iteration is making progress. |
| workspace.tasks[].loop.verificationCriteria | string | No | How the verifier should judge each iteration. |
| workspace.tasks[].loop.successCriteria | string | No | Objective condition that stops the loop successfully. |
| workspace.tasks[].loop.maxIterations | integer | No | — |
| workspace.tasks[].loop.noProgressLimit | integer | No | — |
| workspace.tasks[].loop.minimumScore | number | No | Minimum independently verified score required for success. |
| workspace.tasks[].loop.maxDurationMinutes | integer | No | Wall-clock budget checked between worker/verifier iterations. |
| workspace.tasks[].loop.maxDurationMs | integer | No | Normalized wall-clock budget returned by the runtime. |
| workspace.tasks[].loop.regressionPolicy | continue | stop | No | Whether a materially regressing candidate stops the loop. |
| workspace.tasks[].loop.workerAgentId | string | No | — |
| workspace.tasks[].loop.verifierAgentId | string | No | — |
| workspace.tasks[].sprintId | string | No | — |
| workspace.tasks[].assigneeAgentId | string | No | — |
| workspace.tasks[].dependencyIds | string[] | No | — |
| workspace.tasks[].linkedThreadIds | string[] | No | — |
| workspace.tasks[].lastStartedThreadId | string | No | — |
| workspace.tasks[].scheduledStartAt | string | No | — |
| workspace.tasks[].scheduledEndAt | string | No | — |
| workspace.tasks[].dueAt | string | No | — |
| workspace.tasks[].completedAt | string | No | ISO 8601 timestamp. |
| workspace.tasks[].sortOrder | number | No | — |
| workspace.tasks[].metadata | object | No | Free-form metadata object. |
| workspace.tasks[].createdAt | string | No | ISO 8601 timestamp. |
| workspace.tasks[].updatedAt | string | No | ISO 8601 timestamp. |
| workspace.taskDetailsById | object | No | — |
| workspace.sprints | object[] | No | — |
| workspace.sprints[].id | string | No | Unique identifier. |
| workspace.sprints[].userId | string | No | User ID. |
| workspace.sprints[].organizationId | string | No | — |
| workspace.sprints[].createdByUserId | string | No | — |
| workspace.sprints[].projectId | string | No | Project ID. |
| workspace.sprints[].name | string | No | Human-readable name. |
| workspace.sprints[].goal | string | No | — |
| workspace.sprints[].status | planned | active | completed | No | Current lifecycle status. |
| workspace.sprints[].startAt | string | No | — |
| workspace.sprints[].endAt | string | No | — |
| workspace.sprints[].sortOrder | number | No | — |
| workspace.sprints[].metadata | object | No | Free-form metadata object. |
| workspace.sprints[].createdAt | string | No | ISO 8601 timestamp. |
| workspace.sprints[].updatedAt | string | No | ISO 8601 timestamp. |
| workspace.releases | object[] | No | — |
| workspace.releases[].object | string | No | — |
| workspace.releases[].id | string | No | Unique identifier. |
| workspace.releases[].userId | string | No | User ID. |
| workspace.releases[].organizationId | string | No | — |
| workspace.releases[].createdByUserId | string | No | — |
| workspace.releases[].projectId | string | No | Project ID. |
| workspace.releases[].name | string | No | Human-readable name. |
| workspace.releases[].description | string | No | Human-readable description. |
| workspace.releases[].successCriteria | string[] | No | Measurable conditions that define when this milestone is complete. |
| workspace.releases[].startAt | string | No | — |
| workspace.releases[].endAt | string | No | — |
| workspace.releases[].sortOrder | number | No | — |
| workspace.releases[].status | planned | active | completed | No | Current lifecycle status. |
| workspace.releases[].metadata | object | No | Free-form metadata object. |
| workspace.releases[].taskCount | integer | No | — |
| workspace.releases[].openTaskCount | integer | No | — |
| workspace.releases[].taskIds | string[] | No | — |
| workspace.releases[].createdAt | string | No | ISO 8601 timestamp. |
| workspace.releases[].updatedAt | string | No | ISO 8601 timestamp. |
| workspace.backlogTaskIds | string[] | No | — |
| workspace.board | object | No | — |
| workspace.board.laneOrder | backlog | todo | in_progress | blocked | in_review | done | canceled[] | No | — |
| workspace.board.sprints | object[] | No | — |
| workspace.board.sprints[].sprintId | string | No | — |
| workspace.board.sprints[].sprint | object | No | — |
| workspace.board.sprints[].sprint.id | string | No | Unique identifier. |
| workspace.board.sprints[].sprint.userId | string | No | User ID. |
| workspace.board.sprints[].sprint.organizationId | string | No | — |
| workspace.board.sprints[].sprint.createdByUserId | string | No | — |
| workspace.board.sprints[].sprint.projectId | string | No | Project ID. |
| workspace.board.sprints[].sprint.name | string | No | Human-readable name. |
| workspace.board.sprints[].sprint.goal | string | No | — |
| workspace.board.sprints[].sprint.status | planned | active | completed | No | Current lifecycle status. |
| workspace.board.sprints[].sprint.startAt | string | No | — |
| workspace.board.sprints[].sprint.endAt | string | No | — |
| workspace.board.sprints[].sprint.sortOrder | number | No | — |
| workspace.board.sprints[].sprint.metadata | object | No | Free-form metadata object. |
| workspace.board.sprints[].sprint.createdAt | string | No | ISO 8601 timestamp. |
| workspace.board.sprints[].sprint.updatedAt | string | No | ISO 8601 timestamp. |
| workspace.board.sprints[].lanes | object | No | — |
| workspace.calendar | object | No | — |
| workspace.calendar.rangeStart | string | No | — |
| workspace.calendar.rangeEnd | string | No | — |
| workspace.calendar.items | object[] | No | — |
| workspace.calendar.items[].taskId | string | No | — |
| workspace.calendar.items[].title | string | No | Display title. |
| workspace.calendar.items[].status | backlog | todo | in_progress | blocked | in_review | done | canceled | No | Current lifecycle status. |
| workspace.calendar.items[].sprintId | string | No | — |
| workspace.calendar.items[].assigneeAgentId | string | No | — |
| workspace.calendar.items[].scheduledStartAt | string | No | — |
| workspace.calendar.items[].scheduledEndAt | string | No | — |
| workspace.calendar.items[].dueAt | string | No | — |
| workspace.calendar.items[].blockedByDependencyIds | string[] | No | — |