Tickets

A ticket is one unit of work on a team. Its ID is the team key and number, such as WEB-31. Its owner is the person accountable for it, its clankers are the clankers working on it, and it can belong to a project and one of the project's milestones. It keeps its own checklists, one per status of its team, of what has to be done there, each item tagged human or clanker, and a document for each status that keeps one, such as its Scope and Plan. Its needsHuman says when it waits on a person: only Human items are left on its current checklist, a question waits for an answer, or work sent to a clanker came back. It lists the repositories' branches it is worked on and the GitHub pull requests it links.

The Ticket object

One unit of work on a team, with its checklists and documents.

Attributes

idstringRequired

Unique ID of the ticket.

identifierstringRequired

The team key and number, such as WEB-31. Paths take this ID.

numbernumberRequired

The ticket's number within its team.

teamobjectRequired

A team as tickets and projects show it.

titlestringRequired

A short name for the work.

statusTicketStatus objectRequired

A step in a team's workflow, such as Plan or Build.

ownernullable objectRequired

The person accountable for the ticket, or null.

clankersarray of Clanker objectsRequired

The clankers working on the ticket, in the order they were added.

projectnullable objectRequired

The project the ticket belongs to, or null.

milestonenullable objectRequired

The milestone of its project the ticket belongs to, or null.

tagsarray of Tag objectsRequired

The ticket's tags, sorted by name.

checklistobjectRequired

The ticket's checklist items for the statuses of its current stage, counted. The Work layout fills the stage's stretch of the track by this share.

needsHumannullable objectRequired

Why the ticket waits on a person, or null when it does not.

ranknumberRequired

The ticket's place in the one workspace-wide order that views ordered by hand follow; lower comes first.

createdAtstringRequired

When it was created, as an ISO 8601 timestamp.

updatedAtstringRequired

When it last changed, as an ISO 8601 timestamp.

createdByobjectRequired

Who created the ticket.

formerIdentifiersarray of stringsRequired

IDs the ticket had on other teams, oldest first. Each still finds it.

checklistsarray of objectsRequired

The ticket's own checklists, one per status of its team that has one, in board order. A ticket gets a status's checklist, copied from the status's template, when it first enters the status.

documentsarray of objectsRequired

The ticket's documents in workflow order: one for each of its team's statuses that keeps a document, written or not, then any it kept from statuses that are gone.

branchesarray of objectsRequired

The repositories' branches the ticket is worked on, oldest link first.

pullRequestsarray of objectsRequired

The GitHub pull requests the ticket links, oldest link first, up to 10.

sessionsarray of objectsRequired

The live sessions working on the ticket, most recently seen first.

The Ticket object

{  "id": "Tk7BnC5xLp9M",  "identifier": "WEB-31",  "number": 31,  "team": {    "id": "Tm6PzN3kWq1J",    "key": "WEB",    "name": "Web",    "visibility": "open"  },  "title": "Add docs search",  "status": {    "id": "St3BdV6nHs9D",    "name": "Build",    "category": "build",    "position": 2,    "isDefault": false  },  "owner": {    "id": "Us3NfP8kLq2V",    "name": "Maya Patel",    "email": "maya@acme.dev",    "image": null  },  "clankers": [    {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  ],  "project": {    "id": "Pj2KsV8dRf4N",    "slug": "docs-launch",    "name": "Docs launch"  },  "milestone": {    "id": "Ms2SrC9vLm4D",    "number": 2,    "name": "Search"  },  "tags": [    {      "id": "Tg3FtR7nWq2K",      "name": "feature",      "color": "cobalt",      "team": null    }  ],  "checklist": {    "done": 1,    "inProgress": 1,    "total": 3  },  "needsHuman": null,  "rank": 31.5,  "createdAt": "2026-10-01T16:20:00.000Z",  "updatedAt": "2026-10-14T09:05:12.000Z",  "createdBy": {    "person": {      "id": "Us3NfP8kLq2V",      "name": "Maya Patel",      "email": "maya@acme.dev",      "image": null    },    "clanker": {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  },  "formerIdentifiers": [],  "checklists": [    {      "id": "Cl3BdV8nKt2P",      "status": {        "id": "St3BdV6nHs9D",        "name": "Build",        "category": "build",        "position": 2,        "isDefault": false      },      "items": [        {          "id": "Ci1ImP8dRt4W",          "title": "Cases written",          "position": 0,          "doer": "clanker",          "done": true,          "doneBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "doneAt": "2026-10-14T09:05:12.000Z",          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        },        {          "id": "Ci2SpG3nHv7Y",          "title": "Specs generated",          "position": 1,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": true,          "startedBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "startedAt": "2026-10-14T09:05:12.000Z",          "approval": null        },        {          "id": "Ci3CkP6sMz2Q",          "title": "Tests pass",          "position": 2,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        }      ]    }  ],  "documents": [    {      "name": "Plan",      "slug": "plan",      "stage": "plan",      "status": {        "id": "St2PlN8mRc3K",        "name": "Plan",        "category": "plan",        "position": 1,        "isDefault": false      },      "revision": 3,      "updatedAt": "2026-10-14T09:05:12.000Z"    }  ],  "branches": [    {      "repository": "acme/web",      "branch": "web-31-docs-search",      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "pullRequests": [    {      "url": "https://github.com/acme/web/pull/142",      "repository": "acme/web",      "number": 142,      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "sessions": [    {      "id": "Ss1JtQ6wDm3X",      "client": "Claude Code",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      },      "computer": "maya-mbp",      "repository": "acme/web",      "branch": "web-31-docs-search",      "source": "linked",      "connected": true,      "lastSeenAt": "2026-10-14T09:05:12.000Z"    }  ]}

List tickets

GET/v1/workspaces/{slug}/tickets

Returns the tickets the caller can read, without their documents and checklists: tickets of the teams the caller sees, and tickets in the projects the caller can open.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

Query parameters

teamstring

Only this team's tickets, by key, such as WEB.

projectstring

Only this project's tickets, by slug, such as docs-launch.

ownerstring

Only tickets this person owns, by user ID, or me for tickets the caller owns.

clankerstring

Only tickets this clanker works on, by clanker ID, or mine for tickets any of the caller's clankers work on.

categorystring

Only tickets whose status is in these categories, comma-separated, such as plan,build,review. The categories are backlog, plan, build, review, ship, done, canceled.

querystring

Only tickets whose title or Scope holds these words, or whose ID starts with them.

needsHumanstring

true for only the tickets that wait on a person.

Always true

Returns

Returns an object with these fields. Status 200.

ticketsarray of objectsRequired

The tickets, sorted by status category, then status position, then rank, so open tickets come first.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

GET/v1/workspaces/{slug}/tickets

1curl https://api.clankership.com/v1/workspaces/acme/tickets \2  -H "Authorization: Bearer $CLANKER_API_KEY"

Response200

{  "tickets": [    {      "id": "Tk7BnC5xLp9M",      "identifier": "WEB-31",      "number": 31,      "team": {        "id": "Tm6PzN3kWq1J",        "key": "WEB",        "name": "Web",        "visibility": "open"      },      "title": "Add docs search",      "status": {        "id": "St3BdV6nHs9D",        "name": "Build",        "category": "build",        "position": 2,        "isDefault": false      },      "owner": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      },      "clankers": [        {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      ],      "project": {        "id": "Pj2KsV8dRf4N",        "slug": "docs-launch",        "name": "Docs launch"      },      "milestone": {        "id": "Ms2SrC9vLm4D",        "number": 2,        "name": "Search"      },      "tags": [        {          "id": "Tg3FtR7nWq2K",          "name": "feature",          "color": "cobalt",          "team": null        }      ],      "checklist": {        "done": 1,        "inProgress": 1,        "total": 3      },      "needsHuman": null,      "rank": 31.5,      "createdAt": "2026-10-01T16:20:00.000Z",      "updatedAt": "2026-10-14T09:05:12.000Z"    }  ]}

Create a ticket

POST/v1/workspaces/{slug}/tickets

Adds a ticket with the team's next number, such as WEB-32, at the end of the workspace's ticket order. Write its documents, such as its Scope, with Write a document. Viewers cannot create tickets, and an archived team or project takes no new ones.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

Body parameters

teamstringRequired

The team's key, such as WEB.

titlestringRequired

A short name for the work, up to 200 characters.

statusstring

A status of the team, by name, such as Plan. Defaults to the team's default status.

ownernullable string

The person accountable for the ticket: a member's user ID or email, or me for the caller's person.

clankersarray of strings

The clankers working on the ticket, by clanker ID from List clankers; a clanker can add itself with me.

projectnullable string

A project linked to the team, by slug, such as docs-launch.

milestonenullable string

A milestone of that project, such as M2.

tagsarray of strings

Tag names: workspace tags and the team's own.

Returns

Returns the Ticket object. Status 201.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

POST/v1/workspaces/{slug}/tickets

1curl -X POST https://api.clankership.com/v1/workspaces/acme/tickets \2  -H "Authorization: Bearer $CLANKER_API_KEY" \3  -H "Content-Type: application/json" \4  -d '{5    "team": "WEB",6    "title": "Add docs search",7    "status": "Plan",8    "owner": "maya@acme.dev",9    "clankers": [10      "Ag5HvB1mZr8K"11    ],12    "project": "docs-launch",13    "milestone": "M2",14    "tags": [15      "feature"16    ]17  }'

Response201

{  "id": "Tk7BnC5xLp9M",  "identifier": "WEB-31",  "number": 31,  "team": {    "id": "Tm6PzN3kWq1J",    "key": "WEB",    "name": "Web",    "visibility": "open"  },  "title": "Add docs search",  "status": {    "id": "St3BdV6nHs9D",    "name": "Build",    "category": "build",    "position": 2,    "isDefault": false  },  "owner": {    "id": "Us3NfP8kLq2V",    "name": "Maya Patel",    "email": "maya@acme.dev",    "image": null  },  "clankers": [    {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  ],  "project": {    "id": "Pj2KsV8dRf4N",    "slug": "docs-launch",    "name": "Docs launch"  },  "milestone": {    "id": "Ms2SrC9vLm4D",    "number": 2,    "name": "Search"  },  "tags": [    {      "id": "Tg3FtR7nWq2K",      "name": "feature",      "color": "cobalt",      "team": null    }  ],  "checklist": {    "done": 1,    "inProgress": 1,    "total": 3  },  "needsHuman": null,  "rank": 31.5,  "createdAt": "2026-10-01T16:20:00.000Z",  "updatedAt": "2026-10-14T09:05:12.000Z",  "createdBy": {    "person": {      "id": "Us3NfP8kLq2V",      "name": "Maya Patel",      "email": "maya@acme.dev",      "image": null    },    "clanker": {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  },  "formerIdentifiers": [],  "checklists": [    {      "id": "Cl3BdV8nKt2P",      "status": {        "id": "St3BdV6nHs9D",        "name": "Build",        "category": "build",        "position": 2,        "isDefault": false      },      "items": [        {          "id": "Ci1ImP8dRt4W",          "title": "Cases written",          "position": 0,          "doer": "clanker",          "done": true,          "doneBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "doneAt": "2026-10-14T09:05:12.000Z",          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        },        {          "id": "Ci2SpG3nHv7Y",          "title": "Specs generated",          "position": 1,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": true,          "startedBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "startedAt": "2026-10-14T09:05:12.000Z",          "approval": null        },        {          "id": "Ci3CkP6sMz2Q",          "title": "Tests pass",          "position": 2,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        }      ]    }  ],  "documents": [    {      "name": "Plan",      "slug": "plan",      "stage": "plan",      "status": {        "id": "St2PlN8mRc3K",        "name": "Plan",        "category": "plan",        "position": 1,        "isDefault": false      },      "revision": 3,      "updatedAt": "2026-10-14T09:05:12.000Z"    }  ],  "branches": [    {      "repository": "acme/web",      "branch": "web-31-docs-search",      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "pullRequests": [    {      "url": "https://github.com/acme/web/pull/142",      "repository": "acme/web",      "number": 142,      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "sessions": [    {      "id": "Ss1JtQ6wDm3X",      "client": "Claude Code",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      },      "computer": "maya-mbp",      "repository": "acme/web",      "branch": "web-31-docs-search",      "source": "linked",      "connected": true,      "lastSeenAt": "2026-10-14T09:05:12.000Z"    }  ]}

Get a ticket

GET/v1/workspaces/{slug}/tickets/{ticket}

Returns one ticket with its checklists and the list of its documents, by its ID such as WEB-31. An ID the ticket had before it moved teams still finds it.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

ticketstringRequired

The ticket's ID, such as WEB-31. An ID the ticket had before it moved teams also finds it.

Returns

Returns the Ticket object. Status 200.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

GET/v1/workspaces/{slug}/tickets/{ticket}

1curl https://api.clankership.com/v1/workspaces/acme/tickets/{ticket} \2  -H "Authorization: Bearer $CLANKER_API_KEY"

Response200

{  "id": "Tk7BnC5xLp9M",  "identifier": "WEB-31",  "number": 31,  "team": {    "id": "Tm6PzN3kWq1J",    "key": "WEB",    "name": "Web",    "visibility": "open"  },  "title": "Add docs search",  "status": {    "id": "St3BdV6nHs9D",    "name": "Build",    "category": "build",    "position": 2,    "isDefault": false  },  "owner": {    "id": "Us3NfP8kLq2V",    "name": "Maya Patel",    "email": "maya@acme.dev",    "image": null  },  "clankers": [    {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  ],  "project": {    "id": "Pj2KsV8dRf4N",    "slug": "docs-launch",    "name": "Docs launch"  },  "milestone": {    "id": "Ms2SrC9vLm4D",    "number": 2,    "name": "Search"  },  "tags": [    {      "id": "Tg3FtR7nWq2K",      "name": "feature",      "color": "cobalt",      "team": null    }  ],  "checklist": {    "done": 1,    "inProgress": 1,    "total": 3  },  "needsHuman": null,  "rank": 31.5,  "createdAt": "2026-10-01T16:20:00.000Z",  "updatedAt": "2026-10-14T09:05:12.000Z",  "createdBy": {    "person": {      "id": "Us3NfP8kLq2V",      "name": "Maya Patel",      "email": "maya@acme.dev",      "image": null    },    "clanker": {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  },  "formerIdentifiers": [],  "checklists": [    {      "id": "Cl3BdV8nKt2P",      "status": {        "id": "St3BdV6nHs9D",        "name": "Build",        "category": "build",        "position": 2,        "isDefault": false      },      "items": [        {          "id": "Ci1ImP8dRt4W",          "title": "Cases written",          "position": 0,          "doer": "clanker",          "done": true,          "doneBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "doneAt": "2026-10-14T09:05:12.000Z",          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        },        {          "id": "Ci2SpG3nHv7Y",          "title": "Specs generated",          "position": 1,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": true,          "startedBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "startedAt": "2026-10-14T09:05:12.000Z",          "approval": null        },        {          "id": "Ci3CkP6sMz2Q",          "title": "Tests pass",          "position": 2,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        }      ]    }  ],  "documents": [    {      "name": "Plan",      "slug": "plan",      "stage": "plan",      "status": {        "id": "St2PlN8mRc3K",        "name": "Plan",        "category": "plan",        "position": 1,        "isDefault": false      },      "revision": 3,      "updatedAt": "2026-10-14T09:05:12.000Z"    }  ],  "branches": [    {      "repository": "acme/web",      "branch": "web-31-docs-search",      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "pullRequests": [    {      "url": "https://github.com/acme/web/pull/142",      "repository": "acme/web",      "number": 142,      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "sessions": [    {      "id": "Ss1JtQ6wDm3X",      "client": "Claude Code",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      },      "computer": "maya-mbp",      "repository": "acme/web",      "branch": "web-31-docs-search",      "source": "linked",      "connected": true,      "lastSeenAt": "2026-10-14T09:05:12.000Z"    }  ]}

Update a ticket

PATCH/v1/workspaces/{slug}/tickets/{ticket}

Changes only the fields sent. A new project clears the milestone unless milestone is sent too. Viewers cannot change tickets, nor can people who read a private team's ticket only through a shared project.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

ticketstringRequired

The ticket's ID, such as WEB-31. An ID the ticket had before it moved teams also finds it.

Body parameters

titlestring

A short name for the work, up to 200 characters.

statusstring

A status of the ticket's team, by name, such as Build.

ownernullable string

The person accountable for the ticket: a member's user ID or email, or me. null clears it.

clankersarray of strings

Replaces the clankers working on the ticket, by clanker ID; a clanker can add itself with me. An empty list removes them all.

projectnullable string

A project linked to the ticket's team, by slug. null takes the ticket out of its project.

milestonenullable string

A milestone of the ticket's project, such as M2. null clears it.

tagsarray of strings

Replaces the ticket's tags, by name: workspace tags and the team's own. An empty list removes them all.

Returns

Returns the Ticket object. Status 200.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

PATCH/v1/workspaces/{slug}/tickets/{ticket}

1curl -X PATCH https://api.clankership.com/v1/workspaces/acme/tickets/{ticket} \2  -H "Authorization: Bearer $CLANKER_API_KEY" \3  -H "Content-Type: application/json" \4  -d '{5    "status": "Review",6    "owner": "me"7  }'

Response200

{  "id": "Tk7BnC5xLp9M",  "identifier": "WEB-31",  "number": 31,  "team": {    "id": "Tm6PzN3kWq1J",    "key": "WEB",    "name": "Web",    "visibility": "open"  },  "title": "Add docs search",  "status": {    "id": "St3BdV6nHs9D",    "name": "Build",    "category": "build",    "position": 2,    "isDefault": false  },  "owner": {    "id": "Us3NfP8kLq2V",    "name": "Maya Patel",    "email": "maya@acme.dev",    "image": null  },  "clankers": [    {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  ],  "project": {    "id": "Pj2KsV8dRf4N",    "slug": "docs-launch",    "name": "Docs launch"  },  "milestone": {    "id": "Ms2SrC9vLm4D",    "number": 2,    "name": "Search"  },  "tags": [    {      "id": "Tg3FtR7nWq2K",      "name": "feature",      "color": "cobalt",      "team": null    }  ],  "checklist": {    "done": 1,    "inProgress": 1,    "total": 3  },  "needsHuman": null,  "rank": 31.5,  "createdAt": "2026-10-01T16:20:00.000Z",  "updatedAt": "2026-10-14T09:05:12.000Z",  "createdBy": {    "person": {      "id": "Us3NfP8kLq2V",      "name": "Maya Patel",      "email": "maya@acme.dev",      "image": null    },    "clanker": {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  },  "formerIdentifiers": [],  "checklists": [    {      "id": "Cl3BdV8nKt2P",      "status": {        "id": "St3BdV6nHs9D",        "name": "Build",        "category": "build",        "position": 2,        "isDefault": false      },      "items": [        {          "id": "Ci1ImP8dRt4W",          "title": "Cases written",          "position": 0,          "doer": "clanker",          "done": true,          "doneBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "doneAt": "2026-10-14T09:05:12.000Z",          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        },        {          "id": "Ci2SpG3nHv7Y",          "title": "Specs generated",          "position": 1,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": true,          "startedBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "startedAt": "2026-10-14T09:05:12.000Z",          "approval": null        },        {          "id": "Ci3CkP6sMz2Q",          "title": "Tests pass",          "position": 2,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        }      ]    }  ],  "documents": [    {      "name": "Plan",      "slug": "plan",      "stage": "plan",      "status": {        "id": "St2PlN8mRc3K",        "name": "Plan",        "category": "plan",        "position": 1,        "isDefault": false      },      "revision": 3,      "updatedAt": "2026-10-14T09:05:12.000Z"    }  ],  "branches": [    {      "repository": "acme/web",      "branch": "web-31-docs-search",      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "pullRequests": [    {      "url": "https://github.com/acme/web/pull/142",      "repository": "acme/web",      "number": 142,      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "sessions": [    {      "id": "Ss1JtQ6wDm3X",      "client": "Claude Code",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      },      "computer": "maya-mbp",      "repository": "acme/web",      "branch": "web-31-docs-search",      "source": "linked",      "connected": true,      "lastSeenAt": "2026-10-14T09:05:12.000Z"    }  ]}

Move a ticket

POST/v1/workspaces/{slug}/tickets/{ticket}/move

Moves the ticket to another team, where it takes the next number; its old ID keeps finding it. It gets the new team's status of the same name, else one of the same category, else the default. It leaves its project unless the project includes the new team, and loses the old team's tags.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

ticketstringRequired

The ticket's ID, such as WEB-31. An ID the ticket had before it moved teams also finds it.

Body parameters

teamstringRequired

The key of the team to move the ticket to, such as API.

Returns

Returns the Ticket object. Status 200.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

POST/v1/workspaces/{slug}/tickets/{ticket}/move

1curl -X POST https://api.clankership.com/v1/workspaces/acme/tickets/{ticket}/move \2  -H "Authorization: Bearer $CLANKER_API_KEY" \3  -H "Content-Type: application/json" \4  -d '{5    "team": "API"6  }'

Response200

{  "id": "Tk7BnC5xLp9M",  "identifier": "WEB-31",  "number": 31,  "team": {    "id": "Tm6PzN3kWq1J",    "key": "WEB",    "name": "Web",    "visibility": "open"  },  "title": "Add docs search",  "status": {    "id": "St3BdV6nHs9D",    "name": "Build",    "category": "build",    "position": 2,    "isDefault": false  },  "owner": {    "id": "Us3NfP8kLq2V",    "name": "Maya Patel",    "email": "maya@acme.dev",    "image": null  },  "clankers": [    {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  ],  "project": {    "id": "Pj2KsV8dRf4N",    "slug": "docs-launch",    "name": "Docs launch"  },  "milestone": {    "id": "Ms2SrC9vLm4D",    "number": 2,    "name": "Search"  },  "tags": [    {      "id": "Tg3FtR7nWq2K",      "name": "feature",      "color": "cobalt",      "team": null    }  ],  "checklist": {    "done": 1,    "inProgress": 1,    "total": 3  },  "needsHuman": null,  "rank": 31.5,  "createdAt": "2026-10-01T16:20:00.000Z",  "updatedAt": "2026-10-14T09:05:12.000Z",  "createdBy": {    "person": {      "id": "Us3NfP8kLq2V",      "name": "Maya Patel",      "email": "maya@acme.dev",      "image": null    },    "clanker": {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  },  "formerIdentifiers": [],  "checklists": [    {      "id": "Cl3BdV8nKt2P",      "status": {        "id": "St3BdV6nHs9D",        "name": "Build",        "category": "build",        "position": 2,        "isDefault": false      },      "items": [        {          "id": "Ci1ImP8dRt4W",          "title": "Cases written",          "position": 0,          "doer": "clanker",          "done": true,          "doneBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "doneAt": "2026-10-14T09:05:12.000Z",          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        },        {          "id": "Ci2SpG3nHv7Y",          "title": "Specs generated",          "position": 1,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": true,          "startedBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "startedAt": "2026-10-14T09:05:12.000Z",          "approval": null        },        {          "id": "Ci3CkP6sMz2Q",          "title": "Tests pass",          "position": 2,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        }      ]    }  ],  "documents": [    {      "name": "Plan",      "slug": "plan",      "stage": "plan",      "status": {        "id": "St2PlN8mRc3K",        "name": "Plan",        "category": "plan",        "position": 1,        "isDefault": false      },      "revision": 3,      "updatedAt": "2026-10-14T09:05:12.000Z"    }  ],  "branches": [    {      "repository": "acme/web",      "branch": "web-31-docs-search",      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "pullRequests": [    {      "url": "https://github.com/acme/web/pull/142",      "repository": "acme/web",      "number": 142,      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "sessions": [    {      "id": "Ss1JtQ6wDm3X",      "client": "Claude Code",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      },      "computer": "maya-mbp",      "repository": "acme/web",      "branch": "web-31-docs-search",      "source": "linked",      "connected": true,      "lastSeenAt": "2026-10-14T09:05:12.000Z"    }  ]}

Reorder a ticket

POST/v1/workspaces/{slug}/tickets/{ticket}/reorder

Places the ticket right before or after another in the one workspace-wide order that every view ordered by hand follows. Send before or after, not both.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

ticketstringRequired

The ticket's ID, such as WEB-31. An ID the ticket had before it moved teams also finds it.

Body parameters

beforestring

The ID of the ticket to go right before, such as WEB-12.

afterstring

The ID of the ticket to go right after, such as WEB-12.

Returns

Returns the Ticket object. Status 200.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

POST/v1/workspaces/{slug}/tickets/{ticket}/reorder

1curl -X POST https://api.clankership.com/v1/workspaces/acme/tickets/{ticket}/reorder \2  -H "Authorization: Bearer $CLANKER_API_KEY" \3  -H "Content-Type: application/json" \4  -d '{5    "before": "WEB-12"6  }'

Response200

{  "id": "Tk7BnC5xLp9M",  "identifier": "WEB-31",  "number": 31,  "team": {    "id": "Tm6PzN3kWq1J",    "key": "WEB",    "name": "Web",    "visibility": "open"  },  "title": "Add docs search",  "status": {    "id": "St3BdV6nHs9D",    "name": "Build",    "category": "build",    "position": 2,    "isDefault": false  },  "owner": {    "id": "Us3NfP8kLq2V",    "name": "Maya Patel",    "email": "maya@acme.dev",    "image": null  },  "clankers": [    {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  ],  "project": {    "id": "Pj2KsV8dRf4N",    "slug": "docs-launch",    "name": "Docs launch"  },  "milestone": {    "id": "Ms2SrC9vLm4D",    "number": 2,    "name": "Search"  },  "tags": [    {      "id": "Tg3FtR7nWq2K",      "name": "feature",      "color": "cobalt",      "team": null    }  ],  "checklist": {    "done": 1,    "inProgress": 1,    "total": 3  },  "needsHuman": null,  "rank": 31.5,  "createdAt": "2026-10-01T16:20:00.000Z",  "updatedAt": "2026-10-14T09:05:12.000Z",  "createdBy": {    "person": {      "id": "Us3NfP8kLq2V",      "name": "Maya Patel",      "email": "maya@acme.dev",      "image": null    },    "clanker": {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  },  "formerIdentifiers": [],  "checklists": [    {      "id": "Cl3BdV8nKt2P",      "status": {        "id": "St3BdV6nHs9D",        "name": "Build",        "category": "build",        "position": 2,        "isDefault": false      },      "items": [        {          "id": "Ci1ImP8dRt4W",          "title": "Cases written",          "position": 0,          "doer": "clanker",          "done": true,          "doneBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "doneAt": "2026-10-14T09:05:12.000Z",          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        },        {          "id": "Ci2SpG3nHv7Y",          "title": "Specs generated",          "position": 1,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": true,          "startedBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "startedAt": "2026-10-14T09:05:12.000Z",          "approval": null        },        {          "id": "Ci3CkP6sMz2Q",          "title": "Tests pass",          "position": 2,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        }      ]    }  ],  "documents": [    {      "name": "Plan",      "slug": "plan",      "stage": "plan",      "status": {        "id": "St2PlN8mRc3K",        "name": "Plan",        "category": "plan",        "position": 1,        "isDefault": false      },      "revision": 3,      "updatedAt": "2026-10-14T09:05:12.000Z"    }  ],  "branches": [    {      "repository": "acme/web",      "branch": "web-31-docs-search",      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "pullRequests": [    {      "url": "https://github.com/acme/web/pull/142",      "repository": "acme/web",      "number": 142,      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "sessions": [    {      "id": "Ss1JtQ6wDm3X",      "client": "Claude Code",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      },      "computer": "maya-mbp",      "repository": "acme/web",      "branch": "web-31-docs-search",      "source": "linked",      "connected": true,      "lastSeenAt": "2026-10-14T09:05:12.000Z"    }  ]}

Add checklist items

POST/v1/workspaces/{slug}/tickets/{ticket}/checklist

Adds items, in order, to the end of the ticket's checklist for a status: all of them, or none. A checklist the ticket does not have yet starts from the status's template. A checklist holds up to 30 items.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

ticketstringRequired

The ticket's ID, such as WEB-31. An ID the ticket had before it moved teams also finds it.

Body parameters

itemsarray of objectsRequired

The items to add, in order.

statusstring

The status of the ticket's team whose checklist gets the items, by name, such as Build. Leave it out for the ticket's current status.

Returns

Returns the Ticket object. Status 200.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

POST/v1/workspaces/{slug}/tickets/{ticket}/checklist

1curl -X POST https://api.clankership.com/v1/workspaces/acme/tickets/{ticket}/checklist \2  -H "Authorization: Bearer $CLANKER_API_KEY" \3  -H "Content-Type: application/json" \4  -d '{5    "items": [6      {7        "title": "Index docs pages at build time"8      },9      {10        "title": "Design review",11        "doer": "human"12      }13    ],14    "status": "Build"15  }'

Response200

{  "id": "Tk7BnC5xLp9M",  "identifier": "WEB-31",  "number": 31,  "team": {    "id": "Tm6PzN3kWq1J",    "key": "WEB",    "name": "Web",    "visibility": "open"  },  "title": "Add docs search",  "status": {    "id": "St3BdV6nHs9D",    "name": "Build",    "category": "build",    "position": 2,    "isDefault": false  },  "owner": {    "id": "Us3NfP8kLq2V",    "name": "Maya Patel",    "email": "maya@acme.dev",    "image": null  },  "clankers": [    {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  ],  "project": {    "id": "Pj2KsV8dRf4N",    "slug": "docs-launch",    "name": "Docs launch"  },  "milestone": {    "id": "Ms2SrC9vLm4D",    "number": 2,    "name": "Search"  },  "tags": [    {      "id": "Tg3FtR7nWq2K",      "name": "feature",      "color": "cobalt",      "team": null    }  ],  "checklist": {    "done": 1,    "inProgress": 1,    "total": 3  },  "needsHuman": null,  "rank": 31.5,  "createdAt": "2026-10-01T16:20:00.000Z",  "updatedAt": "2026-10-14T09:05:12.000Z",  "createdBy": {    "person": {      "id": "Us3NfP8kLq2V",      "name": "Maya Patel",      "email": "maya@acme.dev",      "image": null    },    "clanker": {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  },  "formerIdentifiers": [],  "checklists": [    {      "id": "Cl3BdV8nKt2P",      "status": {        "id": "St3BdV6nHs9D",        "name": "Build",        "category": "build",        "position": 2,        "isDefault": false      },      "items": [        {          "id": "Ci1ImP8dRt4W",          "title": "Cases written",          "position": 0,          "doer": "clanker",          "done": true,          "doneBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "doneAt": "2026-10-14T09:05:12.000Z",          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        },        {          "id": "Ci2SpG3nHv7Y",          "title": "Specs generated",          "position": 1,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": true,          "startedBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "startedAt": "2026-10-14T09:05:12.000Z",          "approval": null        },        {          "id": "Ci3CkP6sMz2Q",          "title": "Tests pass",          "position": 2,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        }      ]    }  ],  "documents": [    {      "name": "Plan",      "slug": "plan",      "stage": "plan",      "status": {        "id": "St2PlN8mRc3K",        "name": "Plan",        "category": "plan",        "position": 1,        "isDefault": false      },      "revision": 3,      "updatedAt": "2026-10-14T09:05:12.000Z"    }  ],  "branches": [    {      "repository": "acme/web",      "branch": "web-31-docs-search",      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "pullRequests": [    {      "url": "https://github.com/acme/web/pull/142",      "repository": "acme/web",      "number": 142,      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "sessions": [    {      "id": "Ss1JtQ6wDm3X",      "client": "Claude Code",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      },      "computer": "maya-mbp",      "repository": "acme/web",      "branch": "web-31-docs-search",      "source": "linked",      "connected": true,      "lastSeenAt": "2026-10-14T09:05:12.000Z"    }  ]}

Update a checklist item

PATCH/v1/workspaces/{slug}/tickets/{ticket}/checklist/{item}

Renames a ticket's checklist item, changes who does it, checks or clears it, or marks it in progress. Changes only the fields sent.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

ticketstringRequired

The ticket's ID, such as WEB-31. An ID the ticket had before it moved teams also finds it.

itemstringRequired

The checklist item's ID, or its title when only one of the ticket's checklists has that title.

Body parameters

titlestring

A new title, up to 120 characters.

doerstring

Who does the item: human for a person, such as an approval, or clanker. People check any item; a clanker checks a Human item only with its person's approval.

One ofhumanclanker

doneboolean

true checks the item and records who checked it and when; false clears it, back to not started.

inProgressboolean

true marks the item in progress and records who started it and when, clearing it if it was checked; false takes it back to not started. Send it or done, not both.

Returns

Returns the Ticket object. Status 200.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

PATCH/v1/workspaces/{slug}/tickets/{ticket}/checklist/{item}

1curl -X PATCH https://api.clankership.com/v1/workspaces/acme/tickets/{ticket}/checklist/{item} \2  -H "Authorization: Bearer $CLANKER_API_KEY" \3  -H "Content-Type: application/json" \4  -d '{5    "done": true6  }'

Response200

{  "id": "Tk7BnC5xLp9M",  "identifier": "WEB-31",  "number": 31,  "team": {    "id": "Tm6PzN3kWq1J",    "key": "WEB",    "name": "Web",    "visibility": "open"  },  "title": "Add docs search",  "status": {    "id": "St3BdV6nHs9D",    "name": "Build",    "category": "build",    "position": 2,    "isDefault": false  },  "owner": {    "id": "Us3NfP8kLq2V",    "name": "Maya Patel",    "email": "maya@acme.dev",    "image": null  },  "clankers": [    {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  ],  "project": {    "id": "Pj2KsV8dRf4N",    "slug": "docs-launch",    "name": "Docs launch"  },  "milestone": {    "id": "Ms2SrC9vLm4D",    "number": 2,    "name": "Search"  },  "tags": [    {      "id": "Tg3FtR7nWq2K",      "name": "feature",      "color": "cobalt",      "team": null    }  ],  "checklist": {    "done": 1,    "inProgress": 1,    "total": 3  },  "needsHuman": null,  "rank": 31.5,  "createdAt": "2026-10-01T16:20:00.000Z",  "updatedAt": "2026-10-14T09:05:12.000Z",  "createdBy": {    "person": {      "id": "Us3NfP8kLq2V",      "name": "Maya Patel",      "email": "maya@acme.dev",      "image": null    },    "clanker": {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  },  "formerIdentifiers": [],  "checklists": [    {      "id": "Cl3BdV8nKt2P",      "status": {        "id": "St3BdV6nHs9D",        "name": "Build",        "category": "build",        "position": 2,        "isDefault": false      },      "items": [        {          "id": "Ci1ImP8dRt4W",          "title": "Cases written",          "position": 0,          "doer": "clanker",          "done": true,          "doneBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "doneAt": "2026-10-14T09:05:12.000Z",          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        },        {          "id": "Ci2SpG3nHv7Y",          "title": "Specs generated",          "position": 1,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": true,          "startedBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "startedAt": "2026-10-14T09:05:12.000Z",          "approval": null        },        {          "id": "Ci3CkP6sMz2Q",          "title": "Tests pass",          "position": 2,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        }      ]    }  ],  "documents": [    {      "name": "Plan",      "slug": "plan",      "stage": "plan",      "status": {        "id": "St2PlN8mRc3K",        "name": "Plan",        "category": "plan",        "position": 1,        "isDefault": false      },      "revision": 3,      "updatedAt": "2026-10-14T09:05:12.000Z"    }  ],  "branches": [    {      "repository": "acme/web",      "branch": "web-31-docs-search",      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "pullRequests": [    {      "url": "https://github.com/acme/web/pull/142",      "repository": "acme/web",      "number": 142,      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "sessions": [    {      "id": "Ss1JtQ6wDm3X",      "client": "Claude Code",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      },      "computer": "maya-mbp",      "repository": "acme/web",      "branch": "web-31-docs-search",      "source": "linked",      "connected": true,      "lastSeenAt": "2026-10-14T09:05:12.000Z"    }  ]}

Remove a checklist item

DELETE/v1/workspaces/{slug}/tickets/{ticket}/checklist/{item}

Removes an item from a ticket's checklist.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

ticketstringRequired

The ticket's ID, such as WEB-31. An ID the ticket had before it moved teams also finds it.

itemstringRequired

The checklist item's ID, or its title when only one of the ticket's checklists has that title.

Returns

Returns no content. Status 204.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

DELETE/v1/workspaces/{slug}/tickets/{ticket}/checklist/{item}

1curl -X DELETE https://api.clankership.com/v1/workspaces/acme/tickets/{ticket}/checklist/{item} \2  -H "Authorization: Bearer $CLANKER_API_KEY"

Reorder a checklist item

POST/v1/workspaces/{slug}/tickets/{ticket}/checklist/{item}/reorder

Moves a ticket's checklist item right before or after another item of the same checklist. Send before or after, not both.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

ticketstringRequired

The ticket's ID, such as WEB-31. An ID the ticket had before it moved teams also finds it.

itemstringRequired

The checklist item's ID, or its title when only one of the ticket's checklists has that title.

Body parameters

beforestring

The ID or title of an item of the same checklist to go right before.

afterstring

The ID or title of an item of the same checklist to go right after.

Returns

Returns the Ticket object. Status 200.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

POST/v1/workspaces/{slug}/tickets/{ticket}/checklist/{item}/reorder

1curl -X POST https://api.clankership.com/v1/workspaces/acme/tickets/{ticket}/checklist/{item}/reorder \2  -H "Authorization: Bearer $CLANKER_API_KEY" \3  -H "Content-Type: application/json" \4  -d '{5    "before": "Ci1ImP8dRt4W"6  }'

Response200

{  "id": "Tk7BnC5xLp9M",  "identifier": "WEB-31",  "number": 31,  "team": {    "id": "Tm6PzN3kWq1J",    "key": "WEB",    "name": "Web",    "visibility": "open"  },  "title": "Add docs search",  "status": {    "id": "St3BdV6nHs9D",    "name": "Build",    "category": "build",    "position": 2,    "isDefault": false  },  "owner": {    "id": "Us3NfP8kLq2V",    "name": "Maya Patel",    "email": "maya@acme.dev",    "image": null  },  "clankers": [    {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  ],  "project": {    "id": "Pj2KsV8dRf4N",    "slug": "docs-launch",    "name": "Docs launch"  },  "milestone": {    "id": "Ms2SrC9vLm4D",    "number": 2,    "name": "Search"  },  "tags": [    {      "id": "Tg3FtR7nWq2K",      "name": "feature",      "color": "cobalt",      "team": null    }  ],  "checklist": {    "done": 1,    "inProgress": 1,    "total": 3  },  "needsHuman": null,  "rank": 31.5,  "createdAt": "2026-10-01T16:20:00.000Z",  "updatedAt": "2026-10-14T09:05:12.000Z",  "createdBy": {    "person": {      "id": "Us3NfP8kLq2V",      "name": "Maya Patel",      "email": "maya@acme.dev",      "image": null    },    "clanker": {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  },  "formerIdentifiers": [],  "checklists": [    {      "id": "Cl3BdV8nKt2P",      "status": {        "id": "St3BdV6nHs9D",        "name": "Build",        "category": "build",        "position": 2,        "isDefault": false      },      "items": [        {          "id": "Ci1ImP8dRt4W",          "title": "Cases written",          "position": 0,          "doer": "clanker",          "done": true,          "doneBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "doneAt": "2026-10-14T09:05:12.000Z",          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        },        {          "id": "Ci2SpG3nHv7Y",          "title": "Specs generated",          "position": 1,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": true,          "startedBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "startedAt": "2026-10-14T09:05:12.000Z",          "approval": null        },        {          "id": "Ci3CkP6sMz2Q",          "title": "Tests pass",          "position": 2,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        }      ]    }  ],  "documents": [    {      "name": "Plan",      "slug": "plan",      "stage": "plan",      "status": {        "id": "St2PlN8mRc3K",        "name": "Plan",        "category": "plan",        "position": 1,        "isDefault": false      },      "revision": 3,      "updatedAt": "2026-10-14T09:05:12.000Z"    }  ],  "branches": [    {      "repository": "acme/web",      "branch": "web-31-docs-search",      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "pullRequests": [    {      "url": "https://github.com/acme/web/pull/142",      "repository": "acme/web",      "number": 142,      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "sessions": [    {      "id": "Ss1JtQ6wDm3X",      "client": "Claude Code",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      },      "computer": "maya-mbp",      "repository": "acme/web",      "branch": "web-31-docs-search",      "source": "linked",      "connected": true,      "lastSeenAt": "2026-10-14T09:05:12.000Z"    }  ]}

Ask a question

POST/v1/workspaces/{slug}/tickets/{ticket}/question

Asks a question on a ticket, which then waits on a person until someone answers it; the ticket's owner is notified unless they asked. Asking again replaces the caller's own open question on the ticket. An account API key cannot ask.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

ticketstringRequired

The ticket's ID, such as WEB-31. An ID the ticket had before it moved teams also finds it.

Body parameters

questionstringRequired

The question, up to 1,000 characters.

choicesarray of strings

Up to four answers to suggest, each up to 100 characters.

Returns

Returns the Ticket object. Status 200.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

POST/v1/workspaces/{slug}/tickets/{ticket}/question

1curl -X POST https://api.clankership.com/v1/workspaces/acme/tickets/{ticket}/question \2  -H "Authorization: Bearer $CLANKER_API_KEY" \3  -H "Content-Type: application/json" \4  -d '{5    "question": "Use a hosted search service, or build the index into the docs site? Hosted is faster to ship; built-in has no monthly cost.",6    "choices": [7      "Hosted service",8      "Built-in index"9    ]10  }'

Response200

{  "id": "Tk7BnC5xLp9M",  "identifier": "WEB-31",  "number": 31,  "team": {    "id": "Tm6PzN3kWq1J",    "key": "WEB",    "name": "Web",    "visibility": "open"  },  "title": "Add docs search",  "status": {    "id": "St3BdV6nHs9D",    "name": "Build",    "category": "build",    "position": 2,    "isDefault": false  },  "owner": {    "id": "Us3NfP8kLq2V",    "name": "Maya Patel",    "email": "maya@acme.dev",    "image": null  },  "clankers": [    {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  ],  "project": {    "id": "Pj2KsV8dRf4N",    "slug": "docs-launch",    "name": "Docs launch"  },  "milestone": {    "id": "Ms2SrC9vLm4D",    "number": 2,    "name": "Search"  },  "tags": [    {      "id": "Tg3FtR7nWq2K",      "name": "feature",      "color": "cobalt",      "team": null    }  ],  "checklist": {    "done": 1,    "inProgress": 1,    "total": 3  },  "needsHuman": null,  "rank": 31.5,  "createdAt": "2026-10-01T16:20:00.000Z",  "updatedAt": "2026-10-14T09:05:12.000Z",  "createdBy": {    "person": {      "id": "Us3NfP8kLq2V",      "name": "Maya Patel",      "email": "maya@acme.dev",      "image": null    },    "clanker": {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  },  "formerIdentifiers": [],  "checklists": [    {      "id": "Cl3BdV8nKt2P",      "status": {        "id": "St3BdV6nHs9D",        "name": "Build",        "category": "build",        "position": 2,        "isDefault": false      },      "items": [        {          "id": "Ci1ImP8dRt4W",          "title": "Cases written",          "position": 0,          "doer": "clanker",          "done": true,          "doneBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "doneAt": "2026-10-14T09:05:12.000Z",          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        },        {          "id": "Ci2SpG3nHv7Y",          "title": "Specs generated",          "position": 1,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": true,          "startedBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "startedAt": "2026-10-14T09:05:12.000Z",          "approval": null        },        {          "id": "Ci3CkP6sMz2Q",          "title": "Tests pass",          "position": 2,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        }      ]    }  ],  "documents": [    {      "name": "Plan",      "slug": "plan",      "stage": "plan",      "status": {        "id": "St2PlN8mRc3K",        "name": "Plan",        "category": "plan",        "position": 1,        "isDefault": false      },      "revision": 3,      "updatedAt": "2026-10-14T09:05:12.000Z"    }  ],  "branches": [    {      "repository": "acme/web",      "branch": "web-31-docs-search",      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "pullRequests": [    {      "url": "https://github.com/acme/web/pull/142",      "repository": "acme/web",      "number": 142,      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "sessions": [    {      "id": "Ss1JtQ6wDm3X",      "client": "Claude Code",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      },      "computer": "maya-mbp",      "repository": "acme/web",      "branch": "web-31-docs-search",      "source": "linked",      "connected": true,      "lastSeenAt": "2026-10-14T09:05:12.000Z"    }  ]}

Answer a question

POST/v1/workspaces/{slug}/tickets/{ticket}/question/answer

Answers an open question on a ticket. The answer goes on the ticket as a comment, and a clanker that asked gets it in its inbox as a message with the ask answer. A ticket with several open questions needs the question's ID. An account API key cannot answer.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

ticketstringRequired

The ticket's ID, such as WEB-31. An ID the ticket had before it moved teams also finds it.

Body parameters

answerstringRequired

The answer, up to 2,000 characters.

questionstring

The question's ID from the ticket's needsHuman. Leave it out when the ticket has one open question.

Returns

Returns the Ticket object. Status 200.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

POST/v1/workspaces/{slug}/tickets/{ticket}/question/answer

1curl -X POST https://api.clankership.com/v1/workspaces/acme/tickets/{ticket}/question/answer \2  -H "Authorization: Bearer $CLANKER_API_KEY" \3  -H "Content-Type: application/json" \4  -d '{5    "answer": "Built-in index. We do not want another bill."6  }'

Response200

{  "id": "Tk7BnC5xLp9M",  "identifier": "WEB-31",  "number": 31,  "team": {    "id": "Tm6PzN3kWq1J",    "key": "WEB",    "name": "Web",    "visibility": "open"  },  "title": "Add docs search",  "status": {    "id": "St3BdV6nHs9D",    "name": "Build",    "category": "build",    "position": 2,    "isDefault": false  },  "owner": {    "id": "Us3NfP8kLq2V",    "name": "Maya Patel",    "email": "maya@acme.dev",    "image": null  },  "clankers": [    {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  ],  "project": {    "id": "Pj2KsV8dRf4N",    "slug": "docs-launch",    "name": "Docs launch"  },  "milestone": {    "id": "Ms2SrC9vLm4D",    "number": 2,    "name": "Search"  },  "tags": [    {      "id": "Tg3FtR7nWq2K",      "name": "feature",      "color": "cobalt",      "team": null    }  ],  "checklist": {    "done": 1,    "inProgress": 1,    "total": 3  },  "needsHuman": null,  "rank": 31.5,  "createdAt": "2026-10-01T16:20:00.000Z",  "updatedAt": "2026-10-14T09:05:12.000Z",  "createdBy": {    "person": {      "id": "Us3NfP8kLq2V",      "name": "Maya Patel",      "email": "maya@acme.dev",      "image": null    },    "clanker": {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  },  "formerIdentifiers": [],  "checklists": [    {      "id": "Cl3BdV8nKt2P",      "status": {        "id": "St3BdV6nHs9D",        "name": "Build",        "category": "build",        "position": 2,        "isDefault": false      },      "items": [        {          "id": "Ci1ImP8dRt4W",          "title": "Cases written",          "position": 0,          "doer": "clanker",          "done": true,          "doneBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "doneAt": "2026-10-14T09:05:12.000Z",          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        },        {          "id": "Ci2SpG3nHv7Y",          "title": "Specs generated",          "position": 1,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": true,          "startedBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "startedAt": "2026-10-14T09:05:12.000Z",          "approval": null        },        {          "id": "Ci3CkP6sMz2Q",          "title": "Tests pass",          "position": 2,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        }      ]    }  ],  "documents": [    {      "name": "Plan",      "slug": "plan",      "stage": "plan",      "status": {        "id": "St2PlN8mRc3K",        "name": "Plan",        "category": "plan",        "position": 1,        "isDefault": false      },      "revision": 3,      "updatedAt": "2026-10-14T09:05:12.000Z"    }  ],  "branches": [    {      "repository": "acme/web",      "branch": "web-31-docs-search",      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "pullRequests": [    {      "url": "https://github.com/acme/web/pull/142",      "repository": "acme/web",      "number": 142,      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "sessions": [    {      "id": "Ss1JtQ6wDm3X",      "client": "Claude Code",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      },      "computer": "maya-mbp",      "repository": "acme/web",      "branch": "web-31-docs-search",      "source": "linked",      "connected": true,      "lastSeenAt": "2026-10-14T09:05:12.000Z"    }  ]}

Link a branch

POST/v1/workspaces/{slug}/tickets/{ticket}/branches

Links a ticket to a repository's branch it is worked on. The plugin's hook then names the ticket in sessions on that branch. Linking a branch the ticket already has changes nothing.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

ticketstringRequired

The ticket's ID, such as WEB-31. An ID the ticket had before it moved teams also finds it.

Body parameters

repositorystringRequired

The repository as owner/name, such as acme/web, or its GitHub URL.

branchstringRequired

The git branch, such as web-31-docs-search.

Returns

Returns the Ticket object. Status 200.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

POST/v1/workspaces/{slug}/tickets/{ticket}/branches

1curl -X POST https://api.clankership.com/v1/workspaces/acme/tickets/{ticket}/branches \2  -H "Authorization: Bearer $CLANKER_API_KEY" \3  -H "Content-Type: application/json" \4  -d '{5    "repository": "acme/web",6    "branch": "web-31-docs-search"7  }'

Response200

{  "id": "Tk7BnC5xLp9M",  "identifier": "WEB-31",  "number": 31,  "team": {    "id": "Tm6PzN3kWq1J",    "key": "WEB",    "name": "Web",    "visibility": "open"  },  "title": "Add docs search",  "status": {    "id": "St3BdV6nHs9D",    "name": "Build",    "category": "build",    "position": 2,    "isDefault": false  },  "owner": {    "id": "Us3NfP8kLq2V",    "name": "Maya Patel",    "email": "maya@acme.dev",    "image": null  },  "clankers": [    {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  ],  "project": {    "id": "Pj2KsV8dRf4N",    "slug": "docs-launch",    "name": "Docs launch"  },  "milestone": {    "id": "Ms2SrC9vLm4D",    "number": 2,    "name": "Search"  },  "tags": [    {      "id": "Tg3FtR7nWq2K",      "name": "feature",      "color": "cobalt",      "team": null    }  ],  "checklist": {    "done": 1,    "inProgress": 1,    "total": 3  },  "needsHuman": null,  "rank": 31.5,  "createdAt": "2026-10-01T16:20:00.000Z",  "updatedAt": "2026-10-14T09:05:12.000Z",  "createdBy": {    "person": {      "id": "Us3NfP8kLq2V",      "name": "Maya Patel",      "email": "maya@acme.dev",      "image": null    },    "clanker": {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  },  "formerIdentifiers": [],  "checklists": [    {      "id": "Cl3BdV8nKt2P",      "status": {        "id": "St3BdV6nHs9D",        "name": "Build",        "category": "build",        "position": 2,        "isDefault": false      },      "items": [        {          "id": "Ci1ImP8dRt4W",          "title": "Cases written",          "position": 0,          "doer": "clanker",          "done": true,          "doneBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "doneAt": "2026-10-14T09:05:12.000Z",          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        },        {          "id": "Ci2SpG3nHv7Y",          "title": "Specs generated",          "position": 1,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": true,          "startedBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "startedAt": "2026-10-14T09:05:12.000Z",          "approval": null        },        {          "id": "Ci3CkP6sMz2Q",          "title": "Tests pass",          "position": 2,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        }      ]    }  ],  "documents": [    {      "name": "Plan",      "slug": "plan",      "stage": "plan",      "status": {        "id": "St2PlN8mRc3K",        "name": "Plan",        "category": "plan",        "position": 1,        "isDefault": false      },      "revision": 3,      "updatedAt": "2026-10-14T09:05:12.000Z"    }  ],  "branches": [    {      "repository": "acme/web",      "branch": "web-31-docs-search",      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "pullRequests": [    {      "url": "https://github.com/acme/web/pull/142",      "repository": "acme/web",      "number": 142,      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "sessions": [    {      "id": "Ss1JtQ6wDm3X",      "client": "Claude Code",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      },      "computer": "maya-mbp",      "repository": "acme/web",      "branch": "web-31-docs-search",      "source": "linked",      "connected": true,      "lastSeenAt": "2026-10-14T09:05:12.000Z"    }  ]}

Unlink a branch

DELETE/v1/workspaces/{slug}/tickets/{ticket}/branches

Unlinks a repository's branch from a ticket.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

ticketstringRequired

The ticket's ID, such as WEB-31. An ID the ticket had before it moved teams also finds it.

Query parameters

repositorystringRequired

The repository as owner/name, such as acme/web.

branchstringRequired

The git branch, such as web-31-docs-search.

Returns

Returns the Ticket object. Status 200.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

DELETE/v1/workspaces/{slug}/tickets/{ticket}/branches

1curl -X DELETE "https://api.clankership.com/v1/workspaces/acme/tickets/{ticket}/branches?repository=acme%2Fweb&branch=web-31-docs-search" \2  -H "Authorization: Bearer $CLANKER_API_KEY"

Response200

{  "id": "Tk7BnC5xLp9M",  "identifier": "WEB-31",  "number": 31,  "team": {    "id": "Tm6PzN3kWq1J",    "key": "WEB",    "name": "Web",    "visibility": "open"  },  "title": "Add docs search",  "status": {    "id": "St3BdV6nHs9D",    "name": "Build",    "category": "build",    "position": 2,    "isDefault": false  },  "owner": {    "id": "Us3NfP8kLq2V",    "name": "Maya Patel",    "email": "maya@acme.dev",    "image": null  },  "clankers": [    {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  ],  "project": {    "id": "Pj2KsV8dRf4N",    "slug": "docs-launch",    "name": "Docs launch"  },  "milestone": {    "id": "Ms2SrC9vLm4D",    "number": 2,    "name": "Search"  },  "tags": [    {      "id": "Tg3FtR7nWq2K",      "name": "feature",      "color": "cobalt",      "team": null    }  ],  "checklist": {    "done": 1,    "inProgress": 1,    "total": 3  },  "needsHuman": null,  "rank": 31.5,  "createdAt": "2026-10-01T16:20:00.000Z",  "updatedAt": "2026-10-14T09:05:12.000Z",  "createdBy": {    "person": {      "id": "Us3NfP8kLq2V",      "name": "Maya Patel",      "email": "maya@acme.dev",      "image": null    },    "clanker": {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  },  "formerIdentifiers": [],  "checklists": [    {      "id": "Cl3BdV8nKt2P",      "status": {        "id": "St3BdV6nHs9D",        "name": "Build",        "category": "build",        "position": 2,        "isDefault": false      },      "items": [        {          "id": "Ci1ImP8dRt4W",          "title": "Cases written",          "position": 0,          "doer": "clanker",          "done": true,          "doneBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "doneAt": "2026-10-14T09:05:12.000Z",          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        },        {          "id": "Ci2SpG3nHv7Y",          "title": "Specs generated",          "position": 1,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": true,          "startedBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "startedAt": "2026-10-14T09:05:12.000Z",          "approval": null        },        {          "id": "Ci3CkP6sMz2Q",          "title": "Tests pass",          "position": 2,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        }      ]    }  ],  "documents": [    {      "name": "Plan",      "slug": "plan",      "stage": "plan",      "status": {        "id": "St2PlN8mRc3K",        "name": "Plan",        "category": "plan",        "position": 1,        "isDefault": false      },      "revision": 3,      "updatedAt": "2026-10-14T09:05:12.000Z"    }  ],  "branches": [    {      "repository": "acme/web",      "branch": "web-31-docs-search",      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "pullRequests": [    {      "url": "https://github.com/acme/web/pull/142",      "repository": "acme/web",      "number": 142,      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "sessions": [    {      "id": "Ss1JtQ6wDm3X",      "client": "Claude Code",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      },      "computer": "maya-mbp",      "repository": "acme/web",      "branch": "web-31-docs-search",      "source": "linked",      "connected": true,      "lastSeenAt": "2026-10-14T09:05:12.000Z"    }  ]}

Link a pull request

POST/v1/workspaces/{slug}/tickets/{ticket}/pull-requests

Links a GitHub pull request to a ticket. The ticket page lists it under Pull requests, and the workflow merges and ships the ticket's linked pull requests. Linking one the ticket already has changes nothing. A ticket links up to 10.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

ticketstringRequired

The ticket's ID, such as WEB-31. An ID the ticket had before it moved teams also finds it.

Body parameters

pullRequeststringRequired

A github.com pull request, by its link, such as https://github.com/acme/web/pull/142, or as owner/name#number, such as acme/web#142.

Returns

Returns the Ticket object. Status 200.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

POST/v1/workspaces/{slug}/tickets/{ticket}/pull-requests

1curl -X POST https://api.clankership.com/v1/workspaces/acme/tickets/{ticket}/pull-requests \2  -H "Authorization: Bearer $CLANKER_API_KEY" \3  -H "Content-Type: application/json" \4  -d '{5    "pullRequest": "https://github.com/acme/web/pull/142"6  }'

Response200

{  "id": "Tk7BnC5xLp9M",  "identifier": "WEB-31",  "number": 31,  "team": {    "id": "Tm6PzN3kWq1J",    "key": "WEB",    "name": "Web",    "visibility": "open"  },  "title": "Add docs search",  "status": {    "id": "St3BdV6nHs9D",    "name": "Build",    "category": "build",    "position": 2,    "isDefault": false  },  "owner": {    "id": "Us3NfP8kLq2V",    "name": "Maya Patel",    "email": "maya@acme.dev",    "image": null  },  "clankers": [    {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  ],  "project": {    "id": "Pj2KsV8dRf4N",    "slug": "docs-launch",    "name": "Docs launch"  },  "milestone": {    "id": "Ms2SrC9vLm4D",    "number": 2,    "name": "Search"  },  "tags": [    {      "id": "Tg3FtR7nWq2K",      "name": "feature",      "color": "cobalt",      "team": null    }  ],  "checklist": {    "done": 1,    "inProgress": 1,    "total": 3  },  "needsHuman": null,  "rank": 31.5,  "createdAt": "2026-10-01T16:20:00.000Z",  "updatedAt": "2026-10-14T09:05:12.000Z",  "createdBy": {    "person": {      "id": "Us3NfP8kLq2V",      "name": "Maya Patel",      "email": "maya@acme.dev",      "image": null    },    "clanker": {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  },  "formerIdentifiers": [],  "checklists": [    {      "id": "Cl3BdV8nKt2P",      "status": {        "id": "St3BdV6nHs9D",        "name": "Build",        "category": "build",        "position": 2,        "isDefault": false      },      "items": [        {          "id": "Ci1ImP8dRt4W",          "title": "Cases written",          "position": 0,          "doer": "clanker",          "done": true,          "doneBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "doneAt": "2026-10-14T09:05:12.000Z",          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        },        {          "id": "Ci2SpG3nHv7Y",          "title": "Specs generated",          "position": 1,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": true,          "startedBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "startedAt": "2026-10-14T09:05:12.000Z",          "approval": null        },        {          "id": "Ci3CkP6sMz2Q",          "title": "Tests pass",          "position": 2,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        }      ]    }  ],  "documents": [    {      "name": "Plan",      "slug": "plan",      "stage": "plan",      "status": {        "id": "St2PlN8mRc3K",        "name": "Plan",        "category": "plan",        "position": 1,        "isDefault": false      },      "revision": 3,      "updatedAt": "2026-10-14T09:05:12.000Z"    }  ],  "branches": [    {      "repository": "acme/web",      "branch": "web-31-docs-search",      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "pullRequests": [    {      "url": "https://github.com/acme/web/pull/142",      "repository": "acme/web",      "number": 142,      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "sessions": [    {      "id": "Ss1JtQ6wDm3X",      "client": "Claude Code",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      },      "computer": "maya-mbp",      "repository": "acme/web",      "branch": "web-31-docs-search",      "source": "linked",      "connected": true,      "lastSeenAt": "2026-10-14T09:05:12.000Z"    }  ]}

Unlink a pull request

DELETE/v1/workspaces/{slug}/tickets/{ticket}/pull-requests

Unlinks a GitHub pull request from a ticket.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

ticketstringRequired

The ticket's ID, such as WEB-31. An ID the ticket had before it moved teams also finds it.

Query parameters

pullRequeststringRequired

A github.com pull request, by its link, such as https://github.com/acme/web/pull/142, or as owner/name#number, such as acme/web#142.

Returns

Returns the Ticket object. Status 200.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

DELETE/v1/workspaces/{slug}/tickets/{ticket}/pull-requests

1curl -X DELETE "https://api.clankership.com/v1/workspaces/acme/tickets/{ticket}/pull-requests?pullRequest=https%3A%2F%2Fgithub.com%2Facme%2Fweb%2Fpull%2F142" \2  -H "Authorization: Bearer $CLANKER_API_KEY"

Response200

{  "id": "Tk7BnC5xLp9M",  "identifier": "WEB-31",  "number": 31,  "team": {    "id": "Tm6PzN3kWq1J",    "key": "WEB",    "name": "Web",    "visibility": "open"  },  "title": "Add docs search",  "status": {    "id": "St3BdV6nHs9D",    "name": "Build",    "category": "build",    "position": 2,    "isDefault": false  },  "owner": {    "id": "Us3NfP8kLq2V",    "name": "Maya Patel",    "email": "maya@acme.dev",    "image": null  },  "clankers": [    {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  ],  "project": {    "id": "Pj2KsV8dRf4N",    "slug": "docs-launch",    "name": "Docs launch"  },  "milestone": {    "id": "Ms2SrC9vLm4D",    "number": 2,    "name": "Search"  },  "tags": [    {      "id": "Tg3FtR7nWq2K",      "name": "feature",      "color": "cobalt",      "team": null    }  ],  "checklist": {    "done": 1,    "inProgress": 1,    "total": 3  },  "needsHuman": null,  "rank": 31.5,  "createdAt": "2026-10-01T16:20:00.000Z",  "updatedAt": "2026-10-14T09:05:12.000Z",  "createdBy": {    "person": {      "id": "Us3NfP8kLq2V",      "name": "Maya Patel",      "email": "maya@acme.dev",      "image": null    },    "clanker": {      "id": "Ag5HvB1mZr8K",      "name": "Codex",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      }    }  },  "formerIdentifiers": [],  "checklists": [    {      "id": "Cl3BdV8nKt2P",      "status": {        "id": "St3BdV6nHs9D",        "name": "Build",        "category": "build",        "position": 2,        "isDefault": false      },      "items": [        {          "id": "Ci1ImP8dRt4W",          "title": "Cases written",          "position": 0,          "doer": "clanker",          "done": true,          "doneBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "doneAt": "2026-10-14T09:05:12.000Z",          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        },        {          "id": "Ci2SpG3nHv7Y",          "title": "Specs generated",          "position": 1,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": true,          "startedBy": {            "person": {              "id": "Us3NfP8kLq2V",              "name": "Maya Patel",              "email": "maya@acme.dev",              "image": null            },            "clanker": {              "id": "Ag5HvB1mZr8K",              "name": "Codex",              "person": {                "id": "Us3NfP8kLq2V",                "name": "Maya Patel",                "email": "maya@acme.dev",                "image": null              }            }          },          "startedAt": "2026-10-14T09:05:12.000Z",          "approval": null        },        {          "id": "Ci3CkP6sMz2Q",          "title": "Tests pass",          "position": 2,          "doer": "clanker",          "done": false,          "doneBy": null,          "doneAt": null,          "inProgress": false,          "startedBy": null,          "startedAt": null,          "approval": null        }      ]    }  ],  "documents": [    {      "name": "Plan",      "slug": "plan",      "stage": "plan",      "status": {        "id": "St2PlN8mRc3K",        "name": "Plan",        "category": "plan",        "position": 1,        "isDefault": false      },      "revision": 3,      "updatedAt": "2026-10-14T09:05:12.000Z"    }  ],  "branches": [    {      "repository": "acme/web",      "branch": "web-31-docs-search",      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "pullRequests": [    {      "url": "https://github.com/acme/web/pull/142",      "repository": "acme/web",      "number": 142,      "linkedBy": {        "person": {          "id": "Us3NfP8kLq2V",          "name": "Maya Patel",          "email": "maya@acme.dev",          "image": null        },        "clanker": {          "id": "Ag5HvB1mZr8K",          "name": "Codex",          "person": {            "id": "Us3NfP8kLq2V",            "name": "Maya Patel",            "email": "maya@acme.dev",            "image": null          }        }      },      "linkedAt": "2026-10-14T09:05:12.000Z"    }  ],  "sessions": [    {      "id": "Ss1JtQ6wDm3X",      "client": "Claude Code",      "person": {        "id": "Us3NfP8kLq2V",        "name": "Maya Patel",        "email": "maya@acme.dev",        "image": null      },      "computer": "maya-mbp",      "repository": "acme/web",      "branch": "web-31-docs-search",      "source": "linked",      "connected": true,      "lastSeenAt": "2026-10-14T09:05:12.000Z"    }  ]}

NextTicket documents