Get project
get_projectRetrieve a project's complete details by ID or identifier, including description, status explanation, and parent, to validate references and understand project context.
Instructions
Read one project in full.
Use it after list_projects when you need the description, the status explanation
or the parent of a specific project — or to verify that an id or identifier a user
gave you actually resolves.
Returns {id, identifier, name, active, public, parent, status_code, workspace_type, description, status_explanation, created_at, updated_at}. Rich
text comes back as markdown raw; html is dropped.
Pitfalls: status_code is one of on_track, at_risk, off_track, not_started,
finished, discontinued — an empty status_code means the project has no status
set, not "on track". A 404 here means the id/identifier is wrong or the project is
archived and invisible to this user; the error hint says which spelling to try next.
For the ids valid inside this project (types, versions, categories, time-entry
activities) call get_project_metadata(project_id=...); for its work packages call
list_work_packages(project=...).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id_or_identifier | Yes | Numeric project id (e.g. 7) or the URL identifier (e.g. 'demo-project'). Both are accepted; identifiers come from list_projects, and are the slug in /projects/<identifier>, not the display name. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Numeric project id; accepted by every project_id parameter. | |
| name | No | Display name. | |
| active | No | False for archived projects (read-only in the UI). | |
| parent | No | Parent project, when this is a subproject. | |
| public | No | True when visible to users without a membership. | |
| created_at | No | ISO 8601 UTC timestamp. | |
| identifier | No | URL slug from /projects/<identifier>; also accepted wherever an id is. | |
| updated_at | No | ISO 8601 UTC timestamp. | |
| description | No | Description as markdown (raw); html is dropped. | |
| status_code | No | Project status code, one of: on_track, at_risk, off_track, not_started, finished, discontinued. A code, never a translated label; null means no status has been set. | |
| workspace_type | No | Workspace kind: 'project', 'program' or 'portfolio'. Pre-17 instances only have 'project'; on 17.x project listings mix all three kinds, so check this before treating a row as a plain project. | |
| status_explanation | No | Free-text explanation of status_code, markdown (raw). |