Skip to main content

​
List tickets

Retrieve all tickets for a project, ordered by sort order.

​
Input parameters

​
projectId
string
required
Unique project identifier

​
Response

Returns an array of ticket objects:
​
id
string
Unique ticket identifier (CUID)
​
projectId
string
ID of the parent project
​
title
string
Ticket title
​
type
string
Ticket type: “Story”, “Task”, “Epic”, “Milestone”, or “Deliverable”
​
priority
string
Ticket priority: “P0” (critical), “P1” (high), “P2” (medium), or “P3” (low)
​
description
string
Detailed ticket description
​
acceptanceCriteria
Json
Array of acceptance criteria
​
estimatedEffort
string
Estimated effort: “XS”, “S”, “M”, “L”, or “XL”
​
dependencies
Json
Array of ticket dependencies
​
labels
Json
Array of ticket labels
​
sortOrder
number
default:"0"
Position in the ticket list
​
status
string
default:"todo"
Current ticket status (“todo”, “in-progress”, or “done”)
​
createdAt
DateTime
Ticket creation timestamp
​
updatedAt
DateTime
Last update timestamp

​
Example

Request
{
  "projectId": "clx1234567890"
}
Response
[
  {
    "id": "clx9876543210",
    "projectId": "clx1234567890",
    "title": "Implement user authentication",
    "type": "Story",
    "priority": "P1",
    "description": "Add email/password authentication",
    "acceptanceCriteria": ["Users can register", "Users can login"],
    "estimatedEffort": "M",
    "dependencies": [],
    "labels": ["auth", "security"],
    "sortOrder": 0,
    "status": "in-progress",
    "createdAt": "2026-03-03T10:00:00Z",
    "updatedAt": "2026-03-03T11:00:00Z"
  }
]

​
Update ticket

Update one or more fields of a ticket. Requires authentication and project ownership.

​
Input parameters

​
id
string
required
Unique ticket identifier
​
title
string
Updated ticket title (optional)
​
type
string
Updated ticket type (optional)
​
priority
string
Updated priority (optional)
​
description
string
Updated description (optional)
​
acceptanceCriteria
string[]
Updated acceptance criteria array (optional)
​
estimatedEffort
string
Updated estimated effort (optional)
​
dependencies
string[]
Updated dependencies array (optional)
​
labels
string[]
Updated labels array (optional)
​
status
enum
Updated status: “todo”, “in-progress”, or “done” (optional)

​
Response

Returns the updated ticket object with all fields:
​
id
string
Unique ticket identifier
​
projectId
string
ID of the parent project
​
title
string
Ticket title
​
type
string
Ticket type
​
priority
string
Ticket priority
​
description
string
Ticket description
​
acceptanceCriteria
Json
Acceptance criteria
​
estimatedEffort
string
Estimated effort
​
dependencies
Json
Dependencies
​
labels
Json
Labels
​
sortOrder
number
Sort order
​
status
string
Current status
​
createdAt
DateTime
Creation timestamp
​
updatedAt
DateTime
Last update timestamp

​
Example

Request
{
  "id": "clx9876543210",
  "title": "Implement OAuth authentication",
  "status": "in-progress"
}
Response
{
  "id": "clx9876543210",
  "projectId": "clx1234567890",
  "title": "Implement OAuth authentication",
  "type": "Story",
  "priority": "P1",
  "description": "Add email/password authentication",
  "acceptanceCriteria": ["Users can register", "Users can login"],
  "estimatedEffort": "M",
  "dependencies": [],
  "labels": ["auth", "security"],
  "sortOrder": 0,
  "status": "in-progress",
  "createdAt": "2026-03-03T10:00:00Z",
  "updatedAt": "2026-03-03T12:00:00Z"
}

​
Update ticket status

Update only the status of a ticket. Requires authentication and project ownership.

​
Input parameters

​
id
string
required
Unique ticket identifier
​
status
enum
required
New ticket status: “todo”, “in-progress”, or “done”

​
Response

Returns the updated ticket object with all fields:
​
id
string
Unique ticket identifier
​
projectId
string
ID of the parent project
​
status
string
Updated status
​
updatedAt
DateTime
Last update timestamp

​
Example

Request
{
  "id": "clx9876543210",
  "status": "done"
}
Response
{
  "id": "clx9876543210",
  "projectId": "clx1234567890",
  "title": "Implement OAuth authentication",
  "type": "Story",
  "priority": "P1",
  "description": "Add email/password authentication",
  "acceptanceCriteria": ["Users can register", "Users can login"],
  "estimatedEffort": "M",
  "dependencies": [],
  "labels": ["auth", "security"],
  "sortOrder": 0,
  "status": "done",
  "createdAt": "2026-03-03T10:00:00Z",
  "updatedAt": "2026-03-03T13:00:00Z"
}

​
Delete ticket

Delete a ticket by its ID. Requires authentication and project ownership.

​
Input parameters

​
id
string
required
Unique ticket identifier

​
Response

​
success
boolean
Returns true if deletion was successful

​
Example

Request
{
  "id": "clx9876543210"
}
Response
{
  "success": true
}

Build docs developers (and LLMs) love

Get started for freeTalk to us