Supported operations
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/projects | List all projects |
| GET | /api/v1/projects/:id | Get a project by ID |
| POST | /api/v1/projects | Create a new project |
| PATCH | /api/v1/projects/:id | Update a project |
| DELETE | /api/v1/projects/:id | Delete a project |
| GET | /api/v1/projects/:id/tasks | List tasks for a project |
| POST | /api/v1/projects/:id/tasks | Create a task on a project |
| PATCH | /api/v1/projects/:id/tasks/:taskId | Update a project task |
| DELETE | /api/v1/projects/:id/tasks/:taskId | Delete a project task |
| GET | /api/v1/projects/:id/notes | List notes on a project |
| POST | /api/v1/projects/:id/notes | Add a note to a project |
| PATCH | /api/v1/projects/:id/notes/:noteId | Update a project note |
| DELETE | /api/v1/projects/:id/notes/:noteId | Delete a project note |
| GET | /api/v1/projects/:id/documents | List documents on a project |
| DELETE | /api/v1/projects/:id/documents/:docId | Remove a project document |
| GET | /api/v1/projects/:id/budget | List budget items for a project |
| POST | /api/v1/projects/:id/budget | Add a budget item to a project |
| PATCH | /api/v1/projects/:id/budget/:itemId | Update a project budget item |
| DELETE | /api/v1/projects/:id/budget/:itemId | Delete a project budget item |
| GET | /api/v1/projects/:id/team | List team members on a project |
| POST | /api/v1/projects/:id/team | Add a team member to a project |
| DELETE | /api/v1/projects/:id/team/:memberId | Remove a team member from a project |
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/projects" \
--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) |
siteId | uuid | Optional | site Id Related resource: |
name | string | Required | name |
description | string | Optional | description |
category | enum | Optional | category Values: |
status | enum | Optional | status Values: |
ownerId | uuid | Optional | owner Id Related resource: |
projectLeadId | uuid | Optional | project Lead Id |
startDate | datetime | Optional | start Date |
endDate | datetime | Optional | end Date |
priority | enum | Optional | priority Values: |
phaseId | uuid | Optional | phase Id |
createdAt | datetime | Optional | Creation timestamp (auto) |
updatedAt | datetime | Optional | Last update timestamp (auto) |