Get project phase
get_project_phaseRetrieve a project phase's name, active flag, and definition by its ID. Use it to resolve a project_phase reference from a work package into concrete phase details.
Instructions
Read one project's phase record: name, active flag and its definition.
Use it after get_work_package surfaced a project_phase reference and you
need to know which project and definition that phase belongs to, or whether it is
still active.
Returns {id, name, active, definition, project, created_at, updated_at}.
Pitfalls: the API has no phases index — ids only come from work packages'
project_phase references. Phase dates are not exposed by the API (the notes
say so), so "which projects are in this phase now" goes through
list_projects(in_phase=...) instead. A 404 covers a wrong id, a phase invisible
to this user (view_project_phases), and instances that predate project phases
(16.1).
Cross-references: list_project_phase_definitions for the instance-wide catalog
and gates; list_projects(in_phase=...) for date-based phase queries.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| phase_id | Yes | Per-project phase record id, from a work package's project_phase reference. NOT a definition id from list_project_phase_definitions. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Phase id — a per-project record id, not the definition id. | |
| name | No | Phase name. | |
| notes | No | Degradation notes for this result. | |
| active | No | False when the project switched this phase off. | |
| project | No | Project this phase belongs to. | |
| created_at | No | ISO 8601 UTC timestamp. | |
| definition | No | The instance-global phase definition this instantiates. | |
| updated_at | No | ISO 8601 UTC timestamp. |