Skip to content

All resources

projects

8 endpoints

get /project-templates

List the built-in project templates

Requires authentication

Returns the built-in project templates the create-project modal offers. Static data, served behind auth like every other call.

Responses

  • 200 OK · object
  • 401 Unauthorized · apimodel.ErrorEnvelope

get /projects

List the org's projects

Requires authentication

Returns all projects in the active org with summary stats. Set includeArchived=true to include archived projects.

Parameters

NameInTypeRequiredDescription
includeArchivedquerybooleannoInclude archived projects

Responses

  • 200 OK · object
  • 401 Unauthorized · apimodel.ErrorEnvelope

post /projects

Create a project

Requires authentication

Creates a project in the active org and returns the full canonical project resource.

Request body: dto.CreateProjectRequest

NameTypeRequiredDescription
descriptionstringno
namestringyes
templateIdstringnoTemplateID selects a built-in project template (M1). Empty or unknown → the default "bug-tracker" template. The template pre-seeds columns + feature toggles.

Responses

  • 201 Created · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 401 Unauthorized · apimodel.ErrorEnvelope

get /projects/{id}

Get a project by id

Requires authentication

Returns the project detail including resolved board columns, feature toggles, counts, and GitHub binding.

Parameters

NameInTypeRequiredDescription
idpathintegeryesProject id

Responses

  • 200 OK · object
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope

patch /projects/{id}

Update a project

Requires authentication

Updates the project's mutable fields and returns the full canonical project resource.

Parameters

NameInTypeRequiredDescription
idpathintegeryesProject id

Request body: dto.UpdateProjectRequest

NameTypeRequiredDescription
archivedbooleanno
avatarUrlstringnoAvatarURL sets the project avatar (feat-69). nil = no change, "" clears. Must be a `data:image/...` URL ≤ 100 KB (service- enforced).
columnsstringnoJSON-encoded []domain.ProjectColumn; nil = no change
descriptionstringno
featuresobjectnoFeatures, when non-nil, replaces the project's feature toggles wholesale (M1). nil = no change. The settings UI always sends the full set so partial-update semantics aren't needed.
namestringno

Responses

  • 200 OK · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope

delete /projects/{id}

Delete a project

Requires authentication

Soft-deletes the project and returns a confirmation message.

Parameters

NameInTypeRequiredDescription
idpathintegeryesProject id

Responses

  • 200 OK · object
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope

get /projects/{id}/columns

List a project's columns with task counts

Requires authentication

Returns the project's board columns in board order (key, label, type, color, position and the number of live tasks in each), the configured landing column and the column a new task lands in now. Org owner or admin, or an API token scoped to projects for a project in its scope; a token scoped to other projects is refused.

Parameters

NameInTypeRequiredDescription
idpathintegeryesProject id

Responses

  • 200 OK · object
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 403 Forbidden · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope

put /projects/{id}/columns

Replace a project's columns

Requires authentication

Replaces the project's whole column set, validated like PATCH /projects/{id} (unique keys, known types, at least one done column). A removed column that still has tasks needs an entry in `move` ({"old_key":"new_key"}) naming a column of the new set, otherwise the request is refused with 400 and nothing changes; the tasks are moved in the same transaction. `landingColumn` names the column new tasks land in (omit to keep, "" to clear); it must be a key of the new set, or a removed key that `move` sends elsewhere, and a set with more than one triage-type column must name one. Moving tasks does not send task.status_changed webhooks. Org owner or admin only; API tokens scoped to projects are refused.

Parameters

NameInTypeRequiredDescription
idpathintegeryesProject id

Request body: dto.SetProjectColumnsRequest

NameTypeRequiredDescription
columnsdomain.ProjectColumn[]noColumns is the complete new set, in board order. A column's position is its place in this array unless positions say otherwise (see the service).
landingColumnstringnoLandingColumn names the column new tasks land in. nil keeps the current one, "" clears it. It must be a column of the new set, or a removed column that Move sends elsewhere (it then follows its tasks). A set with more than one triage-type column must name one.
movemap<string>noMove sends the tasks of a REMOVED column to a column of the new set: {"old_key": "new_key"}. A removed column that still has tasks and no entry here refuses the whole request.

Responses

  • 200 OK · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 403 Forbidden · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope