Project Data Structures
Field definitions for key objects returned by Project APIs.
|
ID Format
Resources use prefixed public IDs (for example deal_..., inv_..., form_..., ak_...).
See global ID conventionsProject object
Object representing a project.
Fields
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Required | Project ID |
object | string | Required | Object type (`project.project`) |
organization_id | string | Required | Organization ID |
name | string | Required | Project name |
description | string | null | Optional | Description |
start_date | string | null | Optional | Start date |
end_date | string | null | Optional | End date |
created_at | string | Required | Created at (ISO 8601) |
updated_at | string | Required | Updated at (ISO 8601) |
{
"id": "proj_01JQ3KXYZ",
"object": "project.project",
"organization_id": "org_01HZXYZ",
"name": "Website Redesign",
"description": "Redesign the corporate website",
"start_date": "2026-02-01",
"end_date": "2026-04-30",
"created_at": "2026-01-20T09:00:00Z",
"updated_at": "2026-02-20T10:00:00Z"
}Task object
Object representing a task within a project.
Fields
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Required | Task ID |
object | string | Required | Object type (`project.task`) |
project_id | string | Required | Project ID |
group_id | string | null | Optional | Task group ID |
name | string | Required | Task name |
start_date | string | null | Optional | Start date |
end_date | string | null | Optional | End date |
progress | number | Required | Progress (0-100) |
assigned_to | string | null | Optional | Assignee ID |
created_at | string | Required | Created at (ISO 8601) |
updated_at | string | Required | Updated at (ISO 8601) |
{
"id": "task_01JQ3KABC",
"object": "project.task",
"project_id": "proj_01JQ3KXYZ",
"group_id": "grp_01JQ3KDEF",
"name": "Design mockups",
"start_date": "2026-02-01",
"end_date": "2026-02-14",
"progress": 75,
"assigned_to": "usr_01HZABC",
"created_at": "2026-01-25T09:00:00Z",
"updated_at": "2026-02-18T16:00:00Z"
}Link object
Object representing a dependency link between tasks.
Fields
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Required | Link ID |
object | string | Required | Object type (`project.link`) |
project_id | string | Required | Project ID |
source_id | string | Required | Source task ID |
target_id | string | Required | Target task ID |
type | "finish_to_start" | "start_to_start" | "finish_to_finish" | Required | Link type |
{
"id": "link_01JQ3KGHI",
"object": "project.link",
"project_id": "proj_01JQ3KXYZ",
"source_id": "task_01JQ3KABC",
"target_id": "task_01JQ3KJKL",
"type": "finish_to_start"
}