Get project home snapshot

GET/v1/projects/{projectId}/home

Returns the project configuration and the compact tasks, milestones, environments, and thread records needed to render the project home screen in one request.

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
NameLocationTypeRequiredDescription
projectIdpathstringYesProject ID
Query parameters
None.

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.

200Project home snapshotapplication/json
FieldTypeRequiredDescription
objectproject.homeNo
projectobjectNo
project.idstringNoUnique identifier.
project.userIdstringNoUser ID.
project.ownerUserIdstringNo
project.ownerNamestringNo
project.ownerEmailstringNo
project.ownerAvatarUrlstringNo
project.ownerobjectNo
project.owner.userIdstringYesUser ID.
project.owner.namestringYesHuman-readable name.
project.owner.emailstringNo
project.owner.avatarUrlstringNo
project.canTransferOwnershipbooleanNo
project.organizationIdstringNo
project.createdByUserIdstringNo
project.namestringNoHuman-readable name.
project.descriptionstringNoHuman-readable description.
project.typelocal | cloud | syncedNo
project.primarySourcestringNo
project.sourcesobject[]No
project.createdAtstringNoISO 8601 timestamp.
project.updatedAtstringNoISO 8601 timestamp.
summaryobjectNo
environmentsobject[]No
environments[].idstringNoUnique identifier.
environments[].userIdstringNoUser ID.
environments[].organizationIdstringNo
environments[].createdByUserIdstringNo
environments[].projectIdstringNoProject ID.
environments[].namestringNoHuman-readable name.
environments[].descriptionstringNoHuman-readable description.
environments[].environmentVariablesobject[]No
environments[].environmentVariables[].keystringNo
environments[].environmentVariables[].valuestringNo
environments[].secretsobject[]No
environments[].setupScriptsstring[]No
environments[].mcpServersobject[]No
environments[].mcpServers[].namestringNoHuman-readable name.
environments[].mcpServers[].typestdio | httpNo
environments[].mcpServers[].commandstringNoFor stdio servers
environments[].mcpServers[].argsstring[]No
environments[].mcpServers[].urlstringNoFor HTTP servers
environments[].mcpServers[].bearerTokenstringNo
environments[].mcpServers[].enabledbooleanNo
environments[].internetAccessbooleanNo
environments[].isDefaultbooleanNo
environments[].baseImagestringNo
environments[].dockerfileExtensionsstringNo
environments[].runtimesobjectNo
environments[].packagesobjectNo
environments[].packages.systemstring[]No
environments[].packages.pythonstring[]No
environments[].packages.nodestring[]No
environments[].metadataobjectNoFree-form metadata object.
environments[].metadata.computeProfilelite | standard | power | desktopNoNamed ACP computer profile controlling runtime resources and pricing.
environments[].metadata.computeResourcesobjectNo
environments[].metadata.computeResources.cpuCoresnumberNo
environments[].metadata.computeResources.memoryMbintegerNo
environments[].metadata.pricingobjectNo
environments[].metadata.pricing.minutePricenumberNoRuntime price in USD per minute for the selected computer profile.
environments[].metadata.guiEnabledbooleanNoWhether this computer profile exposes a GUI session.
environments[].metadata.officeAppsEnabledbooleanNoWhether desktop productivity apps are enabled for this computer profile.
environments[].buildStatusstringNo
environments[].buildErrorstringNo
environments[].imageTagstringNo
environments[].lastBuildAtstringNo
environments[].createdAtstringNoISO 8601 timestamp.
environments[].updatedAtstringNoISO 8601 timestamp.
tasksobject[]NoCompact task records without descriptions or embedded attachments, comments, activity, connectors, and enabled-skill payloads.
tasks[].idstringNoUnique identifier.
tasks[].userIdstringNoUser ID.
tasks[].organizationIdstringNo
tasks[].createdByUserIdstringNo
tasks[].creatorobjectNo
tasks[].creator.typeuser | agentYes
tasks[].creator.userIdstringNoUser ID.
tasks[].creator.agentIdstringNoAgent ID.
tasks[].creator.namestringNoHuman-readable name.
tasks[].creator.avatarUrlstringNo
tasks[].projectIdstringNoProject ID.
tasks[].releaseIdstringNo
tasks[].titlestringNoDisplay title.
tasks[].descriptionstringNoHuman-readable description.
tasks[].statusbacklog | todo | in_progress | blocked | in_review | done | canceledNoCurrent lifecycle status.
tasks[].prioritylow | medium | high | urgentNo
tasks[].typetask | subtask | loopNo
tasks[].parentTaskIdstringNo
tasks[].loopobjectNo
tasks[].loop.enabledbooleanNo
tasks[].loop.goalstringNoEnd goal the loop should reach.
tasks[].loop.endGoalstringNoAlias for goal.
tasks[].loop.progressSignalstringNoObservable signal that shows each iteration is making progress.
tasks[].loop.verificationCriteriastringNoHow the verifier should judge each iteration.
tasks[].loop.successCriteriastringNoObjective condition that stops the loop successfully.
tasks[].loop.maxIterationsintegerNo
tasks[].loop.noProgressLimitintegerNo
tasks[].loop.workerAgentIdstringNo
tasks[].loop.verifierAgentIdstringNo
tasks[].sprintIdstringNo
tasks[].assigneeAgentIdstringNo
tasks[].dependencyIdsstring[]No
tasks[].linkedThreadIdsstring[]No
tasks[].lastStartedThreadIdstringNo
tasks[].scheduledStartAtstringNo
tasks[].scheduledEndAtstringNo
tasks[].dueAtstringNo
tasks[].completedAtstringNoISO 8601 timestamp.
tasks[].sortOrdernumberNo
tasks[].metadataobjectNoFree-form metadata object.
tasks[].createdAtstringNoISO 8601 timestamp.
tasks[].updatedAtstringNoISO 8601 timestamp.
releasesobject[]No
releases[].objectstringNo
releases[].idstringNoUnique identifier.
releases[].userIdstringNoUser ID.
releases[].organizationIdstringNo
releases[].createdByUserIdstringNo
releases[].projectIdstringNoProject ID.
releases[].namestringNoHuman-readable name.
releases[].descriptionstringNoHuman-readable description.
releases[].successCriteriastring[]NoMeasurable conditions that define when this milestone is complete.
releases[].startAtstringNo
releases[].endAtstringNo
releases[].sortOrdernumberNo
releases[].statusplanned | active | completedNoCurrent lifecycle status.
releases[].metadataobjectNoFree-form metadata object.
releases[].taskCountintegerNo
releases[].openTaskCountintegerNo
releases[].taskIdsstring[]No
releases[].createdAtstringNoISO 8601 timestamp.
releases[].updatedAtstringNoISO 8601 timestamp.
sprintsobject[]No
sprints[].idstringNoUnique identifier.
sprints[].userIdstringNoUser ID.
sprints[].organizationIdstringNo
sprints[].createdByUserIdstringNo
sprints[].projectIdstringNoProject ID.
sprints[].namestringNoHuman-readable name.
sprints[].goalstringNo
sprints[].statusplanned | active | completedNoCurrent lifecycle status.
sprints[].startAtstringNo
sprints[].endAtstringNo
sprints[].sortOrdernumberNo
sprints[].metadataobjectNoFree-form metadata object.
sprints[].createdAtstringNoISO 8601 timestamp.
sprints[].updatedAtstringNoISO 8601 timestamp.
threadsobject[]NoCompact project thread records without attachments, message previews, or pricing snapshots.
threads[].idstringNoUnique identifier.
threads[].userIdstringNoUser ID.
threads[].organizationIdstringNo
threads[].createdByUserIdstringNo
threads[].projectIdstringNoProject ID.
threads[].environmentIdstringNoComputer ID.
threads[].agentIdstringNoAgent ID.
threads[].titlestringNoDisplay title.
threads[].taskstringNo
threads[].appIdstringNo
threads[].statusactive | running | completed | failed | cancelledNoCurrent lifecycle status.
threads[].messageCountintegerNo
threads[].lastMessageAtstringNo
threads[].lastMessagePreviewstringNo
threads[].inputTokensintegerNo
threads[].outputTokensintegerNo
threads[].totalCostnumberNo
threads[].environmentMinutesnumberNo
threads[].metadataobjectNoFree-form metadata object.
threads[].teamExecutionobjectNo
threads[].teamExecution.modeteamNo
threads[].teamExecution.teamAgentIdstringNo
threads[].teamExecution.teamAgentNamestringNo
threads[].teamExecution.orchestratorobjectNo
threads[].teamExecution.orchestrator.agentIdstringNoAgent ID.
threads[].teamExecution.orchestrator.agentNamestringNo
threads[].teamExecution.orchestrator.claudeAgentNamestringNo
threads[].teamExecution.subagentsobject[]No
threads[].teamExecution.subagents[].agentIdstringNoAgent ID.
threads[].teamExecution.subagents[].agentNamestringNo
threads[].teamExecution.subagents[].claudeAgentNamestringNo
threads[].subagentActivityobject[]No
threads[].subagentActivity[].agentIdstringNoAgent ID.
threads[].subagentActivity[].agentNamestringNo
threads[].subagentActivity[].claudeAgentNamestringNo
threads[].subagentActivity[].eventCountintegerNo
threads[].subagentActivity[].lastActiveAtstringNo
threads[].subagentActivity[].teamAgentIdstringNo
threads[].subagentActivity[].teamAgentNamestringNo
threads[].environmentNamestringNo
threads[].agentNamestringNo
threads[].createdAtstringNoISO 8601 timestamp.
threads[].updatedAtstringNoISO 8601 timestamp.
recentThreadsobject[]No
recentThreads[].idstringNoUnique identifier.
recentThreads[].userIdstringNoUser ID.
recentThreads[].organizationIdstringNo
recentThreads[].createdByUserIdstringNo
recentThreads[].projectIdstringNoProject ID.
recentThreads[].environmentIdstringNoComputer ID.
recentThreads[].agentIdstringNoAgent ID.
recentThreads[].titlestringNoDisplay title.
recentThreads[].taskstringNo
recentThreads[].appIdstringNo
recentThreads[].statusactive | running | completed | failed | cancelledNoCurrent lifecycle status.
recentThreads[].messageCountintegerNo
recentThreads[].lastMessageAtstringNo
recentThreads[].lastMessagePreviewstringNo
recentThreads[].inputTokensintegerNo
recentThreads[].outputTokensintegerNo
recentThreads[].totalCostnumberNo
recentThreads[].environmentMinutesnumberNo
recentThreads[].metadataobjectNoFree-form metadata object.
recentThreads[].teamExecutionobjectNo
recentThreads[].teamExecution.modeteamNo
recentThreads[].teamExecution.teamAgentIdstringNo
recentThreads[].teamExecution.teamAgentNamestringNo
recentThreads[].teamExecution.orchestratorobjectNo
recentThreads[].teamExecution.orchestrator.agentIdstringNoAgent ID.
recentThreads[].teamExecution.orchestrator.agentNamestringNo
recentThreads[].teamExecution.orchestrator.claudeAgentNamestringNo
recentThreads[].teamExecution.subagentsobject[]No
recentThreads[].teamExecution.subagents[].agentIdstringNoAgent ID.
recentThreads[].teamExecution.subagents[].agentNamestringNo
recentThreads[].teamExecution.subagents[].claudeAgentNamestringNo
recentThreads[].subagentActivityobject[]No
recentThreads[].subagentActivity[].agentIdstringNoAgent ID.
recentThreads[].subagentActivity[].agentNamestringNo
recentThreads[].subagentActivity[].claudeAgentNamestringNo
recentThreads[].subagentActivity[].eventCountintegerNo
recentThreads[].subagentActivity[].lastActiveAtstringNo
recentThreads[].subagentActivity[].teamAgentIdstringNo
recentThreads[].subagentActivity[].teamAgentNamestringNo
recentThreads[].environmentNamestringNo
recentThreads[].agentNamestringNo
recentThreads[].createdAtstringNoISO 8601 timestamp.
recentThreads[].updatedAtstringNoISO 8601 timestamp.
404Resource not foundapplication/json
FieldTypeRequiredDescription
errorstringNo
Get project home snapshot
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow