Supported operations
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/phases | List all phases |
| GET | /api/v1/phases/:id | Get a phase by ID |
| POST | /api/v1/phases | Create a new phase |
| PATCH | /api/v1/phases/:id | Update a phase |
| DELETE | /api/v1/phases/:id | Delete a phase |
Example request
Replace YOUR_API_KEY with a private key stored in your environment. Replace path parameters with records from your organization.
curl --request GET "/api/v1/phases" \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Accept: application/json"Field reference
Required means required by the underlying data model, not necessarily caller-supplied. The server derives protected identity and ownership fields; endpoint validation controls which fields are accepted. Sensitive credential fields are omitted here.
| Field | Type | Model requirement | Description |
|---|---|---|---|
id | string | Optional | Unique identifier (auto-generated) |
parentPhaseId | uuid | Optional | parent Phase Id Related resource: |
name | string | Required | name |
description | string | Optional | description |
color | string | Optional | color |
startDate | datetime | Optional | start Date |
endDate | datetime | Optional | end Date |
status | string | Optional | status |
order | number | Optional | order |
createdAt | datetime | Optional | Creation timestamp (auto) |
updatedAt | datetime | Optional | Last update timestamp (auto) |