Skip to content

All resources

canvas

25 endpoints

patch /canvas/cards/{id}

Update a canvas card

Requires authentication

Moves, resizes, recolors, or edits a card's text/body/html. Only the provided fields change.

Parameters

NameInTypeRequiredDescription
idpathintegeryesCanvas card id

Request body: object

No fields documented.

Responses

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

delete /canvas/cards/{id}

Delete a canvas card

Requires authentication

Deletes a card and cascades its edges + comments.

Parameters

NameInTypeRequiredDescription
idpathintegeryesCanvas card id

Responses

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

post /canvas/cards/{id}/assign

Assign (or clear) a canvas card's owner

Requires authentication

Sets the card's assignee; a 0 or null assigneeId clears it.

Parameters

NameInTypeRequiredDescription
idpathintegeryesCanvas card id

Request body: object

No fields documented.

Responses

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

get /canvas/cards/{id}/comments

List a canvas card's comments

Requires authentication

Parameters

NameInTypeRequiredDescription
idpathintegeryesCanvas card id

Responses

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

post /canvas/cards/{id}/comments

Add a comment to a canvas card

Requires authentication

Parameters

NameInTypeRequiredDescription
idpathintegeryesCanvas card id

Request body: object

No fields documented.

Responses

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

get /canvas/cards/{id}/detail

Get a canvas card's detail

Requires authentication

Returns one card with its assignee, tags, linked tasks, and people resolved.

Parameters

NameInTypeRequiredDescription
idpathintegeryesCanvas card id

Responses

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

get /canvas/cards/{id}/people

List the people on a canvas card

Requires authentication

Parameters

NameInTypeRequiredDescription
idpathintegeryesCanvas card id

Responses

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

post /canvas/cards/{id}/people

Add a person to a canvas card

Requires authentication

Parameters

NameInTypeRequiredDescription
idpathintegeryesCanvas card id

Request body: object

No fields documented.

Responses

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

delete /canvas/cards/{id}/people/{userId}

Remove a person from a canvas card

Requires authentication

Parameters

NameInTypeRequiredDescription
idpathintegeryesCanvas card id
userIdpathintegeryesUser id

Responses

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

post /canvas/cards/{id}/promote

Promote a canvas card to a task

Requires authentication

Graduates a card into a real task (bug/feature/change) and flips it to a task_ref.

Parameters

NameInTypeRequiredDescription
idpathintegeryesCanvas card id

Request body: object

No fields documented.

Responses

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

post /canvas/cards/{id}/tags/{tagId}

Add a tag to a canvas card

Requires authentication

Parameters

NameInTypeRequiredDescription
idpathintegeryesCanvas card id
tagIdpathintegeryesTag id

Responses

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

delete /canvas/cards/{id}/tags/{tagId}

Remove a tag from a canvas card

Requires authentication

Parameters

NameInTypeRequiredDescription
idpathintegeryesCanvas card id
tagIdpathintegeryesTag id

Responses

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

get /canvas/cards/{id}/tasks

List a canvas card's linked tasks

Requires authentication

Parameters

NameInTypeRequiredDescription
idpathintegeryesCanvas card id

Responses

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

post /canvas/cards/{id}/tasks

Link a task to a canvas card

Requires authentication

Parameters

NameInTypeRequiredDescription
idpathintegeryesCanvas card id

Request body: object

No fields documented.

Responses

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

delete /canvas/cards/{id}/tasks/{taskId}

Unlink a task from a canvas card

Requires authentication

Parameters

NameInTypeRequiredDescription
idpathintegeryesCanvas card id
taskIdpathintegeryesTask id

Responses

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

post /canvas/cards/{id}/vote

Vote on a canvas card

Requires authentication

Applies a ±1 vote delta to the card (defaults to +1).

Parameters

NameInTypeRequiredDescription
idpathintegeryesCanvas card id

Request body: object

No fields documented.

Responses

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

delete /canvas/comments/{id}

Delete a canvas comment

Requires authentication

Parameters

NameInTypeRequiredDescription
idpathintegeryesCanvas comment id

Responses

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

delete /canvas/edges/{id}

Delete a canvas edge

Requires authentication

Parameters

NameInTypeRequiredDescription
idpathintegeryesCanvas edge id

Responses

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

get /projects/{projectId}/canvas

Get a project's brainstorming board

Requires authentication

Returns the whole canvas board — every card and edge — for the project.

Parameters

NameInTypeRequiredDescription
projectIdpathintegeryesProject id

Responses

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

post /projects/{projectId}/canvas/ai/expand

Expand an idea into a spec

Requires authentication

Fleshes a one-line idea into a short markdown spec.

Parameters

NameInTypeRequiredDescription
projectIdpathintegeryesProject id

Request body: object

No fields documented.

Responses

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

post /projects/{projectId}/canvas/ai/suggest

Suggest fresh ideas

Requires authentication

Returns a handful of idea one-liners to seed the board.

Parameters

NameInTypeRequiredDescription
projectIdpathintegeryesProject id

Request body: object

No fields documented.

Responses

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

post /projects/{projectId}/canvas/ai/widget

Generate a widget card's HTML

Requires authentication

Asks the model for a self-contained HTML artifact for a widget card.

Parameters

NameInTypeRequiredDescription
projectIdpathintegeryesProject id

Request body: object

No fields documented.

Responses

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

post /projects/{projectId}/canvas/cards

Create a canvas card

Requires authentication

Adds a card (sticky, idea, widget, note, …) to the project's board.

Parameters

NameInTypeRequiredDescription
projectIdpathintegeryesProject id

Request body: object

No fields documented.

Responses

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

post /projects/{projectId}/canvas/cursor

Publish a canvas cursor position

Requires authentication

Publishes an ephemeral cursor event to the board topic. Client-throttled; never persisted.

Parameters

NameInTypeRequiredDescription
projectIdpathintegeryesProject id

Request body: object

No fields documented.

Responses

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

post /projects/{projectId}/canvas/edges

Create a canvas edge

Requires authentication

Draws a directed connector between two cards on the board.

Parameters

NameInTypeRequiredDescription
projectIdpathintegeryesProject id

Request body: object

No fields documented.

Responses

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