Projects

Project management operations

List all projects

get

Returns a list of projects accessible to the authenticated user.

• Admins and consultants see all projects within their organization

• Regular users see only projects they own

Authorizations

sessionAuth

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Responses

200

List of projects

application/json

idintegerRequired

Unique project identifier

Example: 1

titlestringRequired

Project title

Example: Q1 Revenue Initiative

descriptionstringRequired

Project description

Example: Cross-functional initiative to increase Q1 revenue by 20%

statusstring · enumRequired

Current project status

Example: activePossible values:

ownerIdintegerRequired

User ID of the project owner

Example: 5

templateIdstring · nullableOptional

Optional template ID the project was created from

Example: template_001

playbookIdstring · nullableOptional

Optional playbook ID associated with the project

Example: playbook_sales_001

startDatestring · date-time · nullableOptional

Project start date

Example: 2026-01-01T00:00:00.000Z

dueDatestring · date-time · nullableOptional

Project due date

Example: 2026-03-31T00:00:00.000Z

metadataobject · nullableOptional

Additional project metadata

createdAtstring · date-timeRequired

Creation timestamp

Example: 2026-01-15T10:30:00.000Z

updatedAtstring · date-timeRequired

Last update timestamp

Example: 2026-01-20T14:45:00.000Z

owner_usernamestringOptional

Username of the project owner

Example: jsmith

401

Not authenticated

text/plain

403

Access denied

application/json

get/projects

HTTPcURLJavaScriptPython

GET /api/projects HTTP/1.1
Accept: */*

[
  {
    "id": 1,
    "title": "Q1 Revenue Initiative",
    "description": "Cross-functional initiative to increase Q1 revenue by 20%",
    "status": "active",
    "ownerId": 5,
    "templateId": "template_001",
    "playbookId": "playbook_sales_001",
    "startDate": "2026-01-01T00:00:00.000Z",
    "dueDate": "2026-03-31T00:00:00.000Z",
    "metadata": {},
    "createdAt": "2026-01-15T10:30:00.000Z",
    "updatedAt": "2026-01-20T14:45:00.000Z",
    "owner_username": "jsmith",
    "tags": [
      {
        "tagId": 1,
        "tag": {
          "id": 1,
          "name": "High Priority",
          "color": "#FF5733",
          "isGlobal": true,
          "categoryId": 2
        }
      }
    ]
  }
]

Create a new project

post

Creates a new project within the authenticated user's organization

Authorizations

sessionAuth

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Body

application/json

titlestringRequired

Project title

Example: New Sales Campaign

descriptionstringRequired

Project description

Example: Launch campaign for new product line

statusstring · enumRequired

Initial project status

Example: activePossible values:

templateIdstring · nullableOptional

Optional template ID to base the project on

playbookIdstring · nullableOptional

Optional playbook ID to associate

startDatestring · date-time · nullableOptional

Project start date (ISO 8601 format)

Example: 2026-02-01T00:00:00.000Z

dueDatestring · date-time · nullableOptional

Project due date (ISO 8601 format)

Example: 2026-04-30T00:00:00.000Z

metadataobject · nullableOptional

Additional metadata

Responses

200

Project created successfully

application/json

idintegerRequired

Unique project identifier

Example: 1

titlestringRequired

Project title

Example: Q1 Revenue Initiative

descriptionstringRequired

Project description

Example: Cross-functional initiative to increase Q1 revenue by 20%

statusstring · enumRequired

Current project status

Example: activePossible values:

ownerIdintegerRequired

User ID of the project owner

Example: 5

templateIdstring · nullableOptional

Optional template ID the project was created from

Example: template_001

playbookIdstring · nullableOptional

Optional playbook ID associated with the project

Example: playbook_sales_001

startDatestring · date-time · nullableOptional

Project start date

Example: 2026-01-01T00:00:00.000Z

dueDatestring · date-time · nullableOptional

Project due date

Example: 2026-03-31T00:00:00.000Z

metadataobject · nullableOptional

Additional project metadata

createdAtstring · date-timeRequired

Creation timestamp

Example: 2026-01-15T10:30:00.000Z

updatedAtstring · date-timeRequired

Last update timestamp

Example: 2026-01-20T14:45:00.000Z

400

Validation error

text/plain

401

Not authenticated

403

Permission denied

application/json

500

Server error

text/plain

post/projects

HTTPcURLJavaScriptPython

POST /api/projects HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 231

{
  "title": "New Sales Campaign",
  "description": "Launch campaign for new product line",
  "status": "active",
  "templateId": "text",
  "playbookId": "text",
  "startDate": "2026-02-01T00:00:00.000Z",
  "dueDate": "2026-04-30T00:00:00.000Z",
  "metadata": {}
}

{
  "id": 1,
  "title": "Q1 Revenue Initiative",
  "description": "Cross-functional initiative to increase Q1 revenue by 20%",
  "status": "active",
  "ownerId": 5,
  "templateId": "template_001",
  "playbookId": "playbook_sales_001",
  "startDate": "2026-01-01T00:00:00.000Z",
  "dueDate": "2026-03-31T00:00:00.000Z",
  "metadata": {},
  "createdAt": "2026-01-15T10:30:00.000Z",
  "updatedAt": "2026-01-20T14:45:00.000Z"
}

Delete a project

delete

Deletes a project. Only project owners or users with delete_projects permission can delete. Projects with related items (tasks, documents, activities) cannot be deleted until those items are removed.

Authorizations

sessionAuth

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

idintegerRequired

Project ID

Responses

204

Project deleted successfully

No content

400

Cannot delete project with related items

text/plain

401

Not authenticated

403

Permission denied

application/json

404

Project not found

text/plain

500

Server error

text/plain

delete/projects/{id}

HTTPcURLJavaScriptPython

DELETE /api/projects/{id} HTTP/1.1
Accept: */*

No content

Update a project

patch

Updates an existing project. Only project owners or users with edit_projects permission can update.

Authorizations

sessionAuth

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

idintegerRequired

Project ID

Body

application/json

titlestringOptional

Updated project title

descriptionstringOptional

Updated project description

statusstring · enumOptional

Updated project status

Possible values:

startDatestring · date-time · nullableOptional

Updated start date (ISO 8601 format or empty string to clear)

dueDatestring · date-time · nullableOptional

Updated due date (ISO 8601 format or empty string to clear)

templateIdstring · nullableOptional

playbookIdstring · nullableOptional

metadataobject · nullableOptional

Responses

200

Project updated successfully

application/json

idintegerRequired

Unique project identifier

Example: 1

titlestringRequired

Project title

Example: Q1 Revenue Initiative

descriptionstringRequired

Project description

Example: Cross-functional initiative to increase Q1 revenue by 20%

statusstring · enumRequired

Current project status

Example: activePossible values:

ownerIdintegerRequired

User ID of the project owner

Example: 5

templateIdstring · nullableOptional

Optional template ID the project was created from

Example: template_001

playbookIdstring · nullableOptional

Optional playbook ID associated with the project

Example: playbook_sales_001

startDatestring · date-time · nullableOptional

Project start date

Example: 2026-01-01T00:00:00.000Z

dueDatestring · date-time · nullableOptional

Project due date

Example: 2026-03-31T00:00:00.000Z

metadataobject · nullableOptional

Additional project metadata

createdAtstring · date-timeRequired

Creation timestamp

Example: 2026-01-15T10:30:00.000Z

updatedAtstring · date-timeRequired

Last update timestamp

Example: 2026-01-20T14:45:00.000Z

400

Invalid date format or validation error

text/plain

401

Not authenticated

403

Permission denied

application/json

404

Project not found

text/plain

500

Server error

text/plain

patch/projects/{id}

HTTPcURLJavaScriptPython

PATCH /api/projects/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "title": "text",
  "description": "text",
  "status": "active",
  "startDate": "2026-07-11T07:51:47.966Z",
  "dueDate": "2026-07-11T07:51:47.966Z",
  "templateId": "text",
  "playbookId": "text",
  "metadata": {}
}

{
  "id": 1,
  "title": "Q1 Revenue Initiative",
  "description": "Cross-functional initiative to increase Q1 revenue by 20%",
  "status": "active",
  "ownerId": 5,
  "templateId": "template_001",
  "playbookId": "playbook_sales_001",
  "startDate": "2026-01-01T00:00:00.000Z",
  "dueDate": "2026-03-31T00:00:00.000Z",
  "metadata": {},
  "createdAt": "2026-01-15T10:30:00.000Z",
  "updatedAt": "2026-01-20T14:45:00.000Z"
}

Duplicate a project

post

Creates a copy of an existing project

Authorizations

sessionAuth

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

idintegerRequired

Project ID to duplicate

Body

application/json

titlestringOptional

New title for the duplicated project

Responses

200

Project duplicated successfully

application/json

idintegerRequired

Unique project identifier

Example: 1

titlestringRequired

Project title

Example: Q1 Revenue Initiative

descriptionstringRequired

Project description

Example: Cross-functional initiative to increase Q1 revenue by 20%

statusstring · enumRequired

Current project status

Example: activePossible values:

ownerIdintegerRequired

User ID of the project owner

Example: 5

templateIdstring · nullableOptional

Optional template ID the project was created from

Example: template_001

playbookIdstring · nullableOptional

Optional playbook ID associated with the project

Example: playbook_sales_001

startDatestring · date-time · nullableOptional

Project start date

Example: 2026-01-01T00:00:00.000Z

dueDatestring · date-time · nullableOptional

Project due date

Example: 2026-03-31T00:00:00.000Z

metadataobject · nullableOptional

Additional project metadata

createdAtstring · date-timeRequired

Creation timestamp

Example: 2026-01-15T10:30:00.000Z

updatedAtstring · date-timeRequired

Last update timestamp

Example: 2026-01-20T14:45:00.000Z

401

Not authenticated

403

Permission denied

404

Project not found

500

Server error

post/projects/{id}/duplicate

HTTPcURLJavaScriptPython

POST /api/projects/{id}/duplicate HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "title": "text"
}

{
  "id": 1,
  "title": "Q1 Revenue Initiative",
  "description": "Cross-functional initiative to increase Q1 revenue by 20%",
  "status": "active",
  "ownerId": 5,
  "templateId": "template_001",
  "playbookId": "playbook_sales_001",
  "startDate": "2026-01-01T00:00:00.000Z",
  "dueDate": "2026-03-31T00:00:00.000Z",
  "metadata": {},
  "createdAt": "2026-01-15T10:30:00.000Z",
  "updatedAt": "2026-01-20T14:45:00.000Z"
}