Projects
Projects represent client engagements, internal initiatives, or any body of work. Assign projects to workflows, track value, manage deliverables, and log time.
The Project Object
Section titled “The Project Object”| Field | Type | Description |
|---|---|---|
id | uuid | |
account_id | uuid | |
created_by | uuid | |
name | string | |
description | string | |
stage_id | uuid? | |
stage_label | string | |
stage_color | string | |
company_id | uuid? | |
company_name | string | |
assigned_to | uuid? | |
assigned_name | string | |
value | int? | |
start_date | string? | |
end_date | string? | |
is_retainer | bool | |
renewal_date | string? | |
timezone | string? | |
notes | string | |
tags | string[] | |
custom_fields | object | |
workflow_id | uuid? | |
created_at | datetime | |
updated_at | datetime |
Link a contact to a project
Section titled “Link a contact to a project”Endpoint: projects-contacts-add
| Field | Type | Required | Description |
|---|---|---|---|
project_id | string | Yes | |
contact_id | string | Yes | |
role | string | No |
curl -X POST https://api.driftwoodapp.com/api/projects-contacts-add \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"project_id": "...", "contact_id": "..."}'List contacts linked to a project
Section titled “List contacts linked to a project”Endpoint: projects-contacts-list
| Field | Type | Required | Description |
|---|---|---|---|
project_id | string | Yes |
curl -X POST https://api.driftwoodapp.com/api/projects-contacts-list \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"project_id": "..."}'Remove a contact from a project
Section titled “Remove a contact from a project”Endpoint: projects-contacts-remove
| Field | Type | Required | Description |
|---|---|---|---|
project_id | string | Yes | |
contact_id | string | Yes |
curl -X POST https://api.driftwoodapp.com/api/projects-contacts-remove \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"project_id": "...", "contact_id": "..."}'Create a new project
Section titled “Create a new project”Endpoint: projects-create
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | |
description | string | No | |
stage_id | string? | No | |
workflow_id | string? | No | |
company_id | string? | No | |
assigned_to | string? | No | |
value | int? | No | |
start_date | string? | No | |
end_date | string? | No | |
is_retainer | bool | No | |
renewal_date | string? | No | |
timezone | string? | No | |
notes | string | No | |
tags | string[] | No | |
custom_fields | object? | No |
curl -X POST https://api.driftwoodapp.com/api/projects-create \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"name": "..."}'Delete a project
Section titled “Delete a project”Endpoint: projects-delete
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes |
curl -X POST https://api.driftwoodapp.com/api/projects-delete \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"id": "..."}'Get a project by ID
Section titled “Get a project by ID”Endpoint: projects-get
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes |
curl -X POST https://api.driftwoodapp.com/api/projects-get \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"id": "..."}'List projects with optional filters
Section titled “List projects with optional filters”Endpoint: projects-list
| Field | Type | Required | Description |
|---|---|---|---|
search | string | No | |
tags | string[] | No | |
stage_id | string? | No | |
company_id | string? | No | |
assigned_to | string? | No | |
cursor | string | No | |
limit | int | No |
curl -X POST https://api.driftwoodapp.com/api/projects-list \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{}'Update an existing project
Section titled “Update an existing project”Endpoint: projects-update
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string? | No | |
description | string? | No | |
stage_id | string? | No | |
company_id | string? | No | |
assigned_to | string? | No | |
value | int? | No | |
start_date | string? | No | |
end_date | string? | No | |
is_retainer | bool? | No | |
renewal_date | string? | No | |
timezone | string? | No | |
notes | string? | No | |
tags | string[] | No | |
custom_fields | object? | No |
curl -X POST https://api.driftwoodapp.com/api/projects-update \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"id": "..."}'