Get a Project by handle or id

GET/o/{org}/p/{project}
View .md

Path parameters

orgstringrequired

The org's slug or id. A caller with no role in the org gets 404.

projectstringrequired

A Project's handle (name) or id, resolved inside {org} — OR the reserved sentinel _ meaning "no Project" (a direct-repo / repo-less dispatch on POST; "no Project constraint, resolve by session id alone" everywhere else). A real handle that doesn't match the session's actual Project is 404.

Responses

200The Project.
projectProjectrequired

The repository is optional Context; installation_id, repo_owner and repo_name are all set or all null.

21 fields
idstringrequired
Format uuid
org_idstringoptional

Owning org (the creator's personal org until projects move between orgs).

Format uuid
user_idstringoptional

The Project's creator; they or an org admin may change its repository.

Format uuid
namestringrequired
installation_idinteger | nullrequired
Format int64
repo_ownerstring | nullrequired
repo_namestring | nullrequired
repo_idinteger | nulloptional
Format int64
default_branchstring | nulloptional
default_harnessstringrequired

Launch-boundary managed harnesses.

One ofclaudecodexopencode
default_harness_versionstring | nulloptional
readinessstringrequired
One ofpendingreadyerror
sync_statusstringoptional
One ofidlesyncingsyncederror
sync_errorstring | nulloptional
last_synced_atstring | nulloptional
Format date-time
created_atstringoptional
Format date-time
updated_atstringoptional
Format date-time
is_defaultbooleanoptional

The project a prompt-only surface (Slack) resolves to. Per user, not per org.

goalstringoptional

What the Project is for; empty when unset.

instructionsstringoptional

Standing instructions every run in the Project receives ahead of its prompt; empty when unset.

paused_atstring | nulloptional

When it was paused: no run or follow-up starts (409 PROJECT_PAUSED) and no automation fires. Null when running.

Format date-time
401No bearer, an unknown, revoked or expired one, or an API key on a route keys cannot call.
errorstringoptional

A sentence for a person.

codestringoptional

Stable machine code, e.g. AUTH_FAILED, NOT_FOUND, VALIDATION_ERROR, RATE_LIMITED, TOKEN_LIMIT_REACHED.

error_codestringoptional

The machine code on routes that name it this way.

messagestringoptional
requestIdstringoptional
404No such resource for the caller, including one that exists in an org the caller cannot see.
errorstringoptional

A sentence for a person.

codestringoptional

Stable machine code, e.g. AUTH_FAILED, NOT_FOUND, VALIDATION_ERROR, RATE_LIMITED, TOKEN_LIMIT_REACHED.

error_codestringoptional

The machine code on routes that name it this way.

messagestringoptional
requestIdstringoptional