Get project

GET/v1/projects/{projectId}

Get project details and statistics

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
NameLocationTypeRequiredDescription
viewquerymetadataNoUse `metadata` for the lightweight project record without summaries, environments, or threads.

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 detailsapplication/json
FieldTypeRequiredDescription
projectobjectNo—
project.objectproject | project.overviewNo—
project.isOverviewRecordbooleanNo—
project.idstringYesUnique identifier.
project.userIdstringYesUser 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.createdByNamestringNo—
project.createdByEmailstringNo—
project.createdByAvatarUrlstringNo—
project.createdByobjectNo—
project.createdBy.userIdstringYesUser ID.
project.createdBy.namestringYesHuman-readable name.
project.createdBy.emailstringNo—
project.createdBy.avatarUrlstringNo—
project.namestringYesHuman-readable name.
project.descriptionstringYesHuman-readable description.
project.typelocal | cloud | syncedNo—
project.primarySourcestringNo—
project.sourcesobject[]No—
project.colorstringYes—
project.defaultEnvironmentIdstringYes—
project.environmentIdsstring[]No—
project.permissionSetobjectNoAgent permission policy. The shape is intentionally subject-typed so it can also be reused for human users and teams later.
project.permissionSet.version1No—
project.permissionSet.subjectTypeagent | human_user | team | project | security_repositoryNo—
project.permissionSet.defaultAccessfull_access | ask_for_permission | read_only | no_accessNoAccess level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access.
project.permissionSet.ringsobjectNo—
project.permissionSet.actionsobjectNo—
project.permissionSet.resourcesobjectNo—
project.permissionSet.resources.agentsobjectNo—
project.permissionSet.resources.agents.defaultAccessfull_access | ask_for_permission | read_only | no_accessNoAccess level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access.
project.permissionSet.resources.agents.rulesobject[]No—
project.permissionSet.resources.agents.rules[].idstringNoOptional stable rule ID.
project.permissionSet.resources.agents.rules[].targetIdstringNoOptional resource identifier for agent, skill, server, computer, or project rules.
project.permissionSet.resources.agents.rules[].pathstringNoOptional file or directory path for path-scoped rules.
project.permissionSet.resources.agents.rules[].accessfull_access | ask_for_permission | read_only | no_accessNoAccess level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access.
project.permissionSet.resources.agents.rules[].notestringNoOptional human-readable note for the rule.
project.permissionSet.resources.skillsobjectNo—
project.permissionSet.resources.skills.defaultAccessfull_access | ask_for_permission | read_only | no_accessNoAccess level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access.
project.permissionSet.resources.skills.rulesobject[]No—
project.permissionSet.resources.skills.rules[].idstringNoOptional stable rule ID.
project.permissionSet.resources.skills.rules[].targetIdstringNoOptional resource identifier for agent, skill, server, computer, or project rules.
project.permissionSet.resources.skills.rules[].pathstringNoOptional file or directory path for path-scoped rules.
project.permissionSet.resources.skills.rules[].accessfull_access | ask_for_permission | read_only | no_accessNoAccess level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access.
project.permissionSet.resources.skills.rules[].notestringNoOptional human-readable note for the rule.
project.permissionSet.resources.serversobjectNo—
project.permissionSet.resources.servers.defaultAccessfull_access | ask_for_permission | read_only | no_accessNoAccess level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access.
project.permissionSet.resources.servers.rulesobject[]No—
project.permissionSet.resources.servers.rules[].idstringNoOptional stable rule ID.
project.permissionSet.resources.servers.rules[].targetIdstringNoOptional resource identifier for agent, skill, server, computer, or project rules.
project.permissionSet.resources.servers.rules[].pathstringNoOptional file or directory path for path-scoped rules.
project.permissionSet.resources.servers.rules[].accessfull_access | ask_for_permission | read_only | no_accessNoAccess level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access.
project.permissionSet.resources.servers.rules[].notestringNoOptional human-readable note for the rule.
project.permissionSet.resources.computersobjectNo—
project.permissionSet.resources.computers.defaultAccessfull_access | ask_for_permission | read_only | no_accessNoAccess level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access.
project.permissionSet.resources.computers.rulesobject[]No—
project.permissionSet.resources.computers.rules[].idstringNoOptional stable rule ID.
project.permissionSet.resources.computers.rules[].targetIdstringNoOptional resource identifier for agent, skill, server, computer, or project rules.
project.permissionSet.resources.computers.rules[].pathstringNoOptional file or directory path for path-scoped rules.
project.permissionSet.resources.computers.rules[].accessfull_access | ask_for_permission | read_only | no_accessNoAccess level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access.
project.permissionSet.resources.computers.rules[].notestringNoOptional human-readable note for the rule.
project.permissionSet.resources.filesobjectNo—
project.permissionSet.resources.files.defaultAccessfull_access | ask_for_permission | read_only | no_accessNoAccess level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access.
project.permissionSet.resources.files.rulesobject[]No—
project.permissionSet.resources.files.rules[].idstringNoOptional stable rule ID.
project.permissionSet.resources.files.rules[].targetIdstringNoOptional resource identifier for agent, skill, server, computer, or project rules.
project.permissionSet.resources.files.rules[].pathstringNoOptional file or directory path for path-scoped rules.
project.permissionSet.resources.files.rules[].accessfull_access | ask_for_permission | read_only | no_accessNoAccess level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access.
project.permissionSet.resources.files.rules[].notestringNoOptional human-readable note for the rule.
project.permissionSet.resources.directoriesobjectNo—
project.permissionSet.resources.directories.defaultAccessfull_access | ask_for_permission | read_only | no_accessNoAccess level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access.
project.permissionSet.resources.directories.rulesobject[]No—
project.permissionSet.resources.directories.rules[].idstringNoOptional stable rule ID.
project.permissionSet.resources.directories.rules[].targetIdstringNoOptional resource identifier for agent, skill, server, computer, or project rules.
project.permissionSet.resources.directories.rules[].pathstringNoOptional file or directory path for path-scoped rules.
project.permissionSet.resources.directories.rules[].accessfull_access | ask_for_permission | read_only | no_accessNoAccess level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access.
project.permissionSet.resources.directories.rules[].notestringNoOptional human-readable note for the rule.
project.permissionSet.resources.projectsobjectNo—
project.permissionSet.resources.projects.defaultAccessfull_access | ask_for_permission | read_only | no_accessNoAccess level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access.
project.permissionSet.resources.projects.rulesobject[]No—
project.permissionSet.resources.projects.rules[].idstringNoOptional stable rule ID.
project.permissionSet.resources.projects.rules[].targetIdstringNoOptional resource identifier for agent, skill, server, computer, or project rules.
project.permissionSet.resources.projects.rules[].pathstringNoOptional file or directory path for path-scoped rules.
project.permissionSet.resources.projects.rules[].accessfull_access | ask_for_permission | read_only | no_accessNoAccess level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access.
project.permissionSet.resources.projects.rules[].notestringNoOptional human-readable note for the rule.
project.permissionSet.resources.security_repositoriesobjectNo—
project.permissionSet.resources.security_repositories.defaultAccessfull_access | ask_for_permission | read_only | no_accessNoAccess level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access.
project.permissionSet.resources.security_repositories.rulesobject[]No—
project.permissionSet.resources.security_repositories.rules[].idstringNoOptional stable rule ID.
project.permissionSet.resources.security_repositories.rules[].targetIdstringNoOptional resource identifier for agent, skill, server, computer, or project rules.
project.permissionSet.resources.security_repositories.rules[].pathstringNoOptional file or directory path for path-scoped rules.
project.permissionSet.resources.security_repositories.rules[].accessfull_access | ask_for_permission | read_only | no_accessNoAccess level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access.
project.permissionSet.resources.security_repositories.rules[].notestringNoOptional human-readable note for the rule.
project.metadataobjectYesFree-form metadata object.
project.sharedWithMebooleanNo—
project.isSharedbooleanNo—
project.teamSharedbooleanNo—
project.teamShareIdstringNo—
project.teamIdstringNo—
project.teamNamestringNo—
project.teamAccessLeveluse | edit | manageNo—
project.teamShareSourceresource_share | project_settingsNo—
project.summaryobjectNo—
project.createdAtstringYesISO 8601 timestamp.
project.updatedAtstringYesISO 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.
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 | permission_asked | completed | failed | archived | cancelled | deletedNoCurrent lifecycle status.
recentThreads[].contextIdstringNo—
recentThreads[].contextNamestringNo—
recentThreads[].messageCountintegerNo—
recentThreads[].lastMessageAtstringNo—
recentThreads[].lastMessagePreviewstringNo—
recentThreads[].inputTokensintegerNo—
recentThreads[].outputTokensintegerNo—
recentThreads[].cacheTokensintegerNo—
recentThreads[].totalTokensintegerNo—
recentThreads[].agentCostnumberNo—
recentThreads[].agentCostUsdnumberNo—
recentThreads[].environmentCostnumberNo—
recentThreads[].environmentCostUsdnumberNo—
recentThreads[].totalCostnumberNo—
recentThreads[].totalCostUsdnumberNo—
recentThreads[].agentCTintegerNo—
recentThreads[].environmentCTintegerNo—
recentThreads[].totalCTintegerNo—
recentThreads[].environmentMinutesnumberNo—
recentThreads[].environmentStorageGBnumberNo—
recentThreads[].attachmentsobject[]No—
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[].agentPhotoUrlstringNo—
recentThreads[].agentAvatarUrlstringNo—
recentThreads[].startedAtstringNoISO 8601 timestamp.
recentThreads[].completedAtstringNoISO 8601 timestamp.
recentThreads[].durationstringNo—
recentThreads[].queuedInBatchbooleanNo—
recentThreads[].batchJobIdstringNo—
recentThreads[].admissionReasonstringNo—
recentThreads[].createdAtstringNoISO 8601 timestamp.
recentThreads[].updatedAtstringNoISO 8601 timestamp.
404Resource not foundapplication/json
FieldTypeRequiredDescription
errorstringNo—
Get project
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow