Cards

Create card

Creates a card within a list. Requires board editor permissions.

post/lists/{listId}/cards

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/lists/{listId}/cards
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

listIdstring required
Example:1357158568008091264

ID of the list to create the card in

Request body

type'project' | 'story' required

Type of the card

positionnumber nullable

Position of the card within the list

namestring required

Name/title of the card

descriptionstring nullable

Detailed description of the card

dueDatestring date-time

Due date for the card

isDueCompletedboolean nullable

Whether the due date is completed

Example request

{
  "type": "project",
  "position": 65536,
  "name": "Implement user authentication",
  "description": "Add JWT-based authentication system...",
  "dueDate": "2024-01-01T00:00:00.000Z",
  "stopwatch": {
    "startedAt": "2024-01-01T00:00:00.000Z",
    "total": 3600
  }
}

Response

Card created successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "boardId": "1357158568008091265",
    "listId": "1357158568008091266",
    "creatorUserId": "1357158568008091267",
    "prevListId": "1357158568008091268",
    "coverAttachmentId": "1357158568008091269",
    "type": "project",
    "position": 65536,
    "name": "Implement user authentication",
    "description": "Add JWT-based authentication system...",
    "dueDate": "2024-01-01T00:00:00.000Z",
    "stopwatch": {
      "startedAt": "2024-01-01T00:00:00.000Z",
      "total": 3600
    },
    "commentsTotal": 100,
    "listChangedAt": "2024-01-01T00:00:00.000Z",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.