Projects

Create, update, archive, and list projects within your workspace.

Endpoints

List all projects in your workspace

Scope

projects:read

Response

{
  "projects": [
    {
      "id": "prj_abc123",
      "name": "Product Launch",
      "slug": "product-launch",
      "description": "Q1 product launch updates",
      "color": "#3B82F6",
      "visibility": "public",
      "archived": false,
      "createdAt": "2024-01-10T08:00:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ]
}

Create a new project

Scope

projects:write

Parameters

namestringrequiredProject name (max 100 chars)

descriptionstringProject description

colorstringProject color (hex, e.g. #3B82F6)

visibilitystringpublic or private (default: public)

Get a single project by ID

Scope

projects:read

Parameters

idstringrequiredProject ID (URL path)

Update an existing project

Scope

projects:write

Parameters

idstringrequiredProject ID (URL path)

namestringNew project name (max 100 chars)

descriptionstringNew description

colorstringNew color (hex)

visibilitystringpublic or private

archivedbooleanSet to true to archive

Archive a project

Scope

projects:write

Parameters

idstringrequiredProject ID (URL path)

Project Visibility

publicVisible to all workspace members. Default for new projects.

privateOnly visible to explicitly added members.

Archiving Projects

Projects can be archived using POST /projects/:id/archive or by setting archived: true via PATCH /projects/:id. Archived projects are hidden from the default project list. To unarchive, use PATCH /projects/:id with archived: false.

Archiving is a soft delete — no data is permanently removed.

Permissions

Reading projects requires the projects:read scope. Creating, updating, and archiving projects requires the projects:write scope.