# Team API
The Team API gives external scripts, automations and Claude Code sessions full read/write access to Team Projects: creating and updating tasks, managing members, appending notes to descriptions and more.
> [!quote] Automate your team's work
> The actions in the Zaphiri Team Project interface are available through this API. If a tool can send an HTTP request, it can manage your Team Projects.
All team endpoints use **integration token authentication**, with the same tokens used for the [[API-Reference/Webhooks|webhook Inbox]]. No JWT setup is needed.
**Base path:** `https://tickup-api.mytickup.com/api/v1/team`
---
## Authentication
All team endpoints require an integration token in the `Authorization` header:
```
Authorization: Bearer <integration-token>
```
Integration tokens are created in **Zaphiri → Settings → API**. The authenticated account must be a **member of the project** for project and task operations. The API returns `403` if it is not.
> [!warning] Token scope
> Each integration token authenticates as the person who created it. That person must be a member of the relevant Team Project, or the main Zaphiri API returns 403.
---
## Projects
### List Projects
Returns all Team Projects the authenticated account is a member of.
```
GET /api/v1/team/projects
```
**Response `200 OK`**
```json
[
{
"id": "2df072bf-49be-4b25-8f83-6ff778ca767a",
"owner_user_id": "454df697-...",
"name": "Zaphiri",
"color": "bg-violet-500",
"icon": "",
"created_at": "2026-05-22T15:08:14Z",
"members": [
{
"id": "1280b29e-...",
"user_id": "454df697-...",
"name": "Lonny H",
"initials": "LH",
"color": "bg-violet-500",
"role": "owner",
"capacity": null
}
],
"task_count": 12
}
]
```
**curl**
```bash
curl -H "Authorization: Bearer $TOKEN" \
https://tickup-api.mytickup.com/api/v1/team/projects
```
---
### Create Project
```
POST /api/v1/team/projects
```
**Request Body**
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `name` | string | Yes | Project name |
| `color` | string | No | Tailwind colour class, for example `"bg-violet-500"`, `"bg-white"`, `"bg-gray-100"` |
| `icon` | string | No | Emoji icon, for example `"🚀"` |
**curl**
```bash
curl -X POST https://tickup-api.mytickup.com/api/v1/team/projects \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name": "New Project", "color": "bg-violet-500"}'
```
---
### Update Project
```
PUT /api/v1/team/projects/{projectId}
```
**Request Body**
| Field | Type | Description |
|-------|------|-------------|
| `name` | string | New project name |
| `color` | string | Tailwind colour class |
| `icon` | string | Emoji icon, for example `"🚀"` |
---
### Delete Project
```
DELETE /api/v1/team/projects/{projectId}
```
---
## Project Settings
Project settings control the available statuses, custom fields and visible columns.
### Get Settings
```
GET /api/v1/team/projects/{projectId}/settings
```
**Response `200 OK`**
```json
{
"statuses": [
{ "id": "todo", "name": "To Do","color": "bg-neutral-600 text-neutral-200" },
{ "id": "in_progress", "name": "In Progress", "color": "bg-blue-600 text-white" },
{ "id": "in_review", "name": "In Review", "color": "bg-purple-600 text-white" },
{ "id": "done", "name": "Done", "color": "bg-green-600 text-white" }
],
"fields": [
{
"id": "sprint",
"name": "Sprint",
"type": "select",
"options": ["Sprint 1", "Sprint 2"],
"optionColors": { "Sprint 1": "bg-blue-500", "Sprint 2": "bg-green-500" },
"builtin": false
}
],
"columns": {
"status": true,
"priority": true,
"assignees": true,
"sprint": true
},
"columnOrder": ["status", "priority", "assignees", "sprint"],
"inProgressStatusId": "in_progress",
"pinnedFields": []
}
```
### Update Settings
Fetch the current settings, modify the object, and PUT it back. To add a status, push to the `statuses` array. To add a custom field, push to the `fields` array.
```
PUT /api/v1/team/projects/{projectId}/settings
```
Send the full settings object (same shape as the GET response).
**Status object shape:** `{ "id": "snake_case_id", "name": "Display Name", "color": "bg-X-600 text-white" }`
**Field types:** `"select"` (with `options` array and optional `optionColors` map), `"text"`, `"number"`, `"date"`, `"member"`, `"url"`
**Field flags:** `"builtin": true` marks fields that ship with the project template and cannot be deleted.
**curl: add a status**
```bash
SETTINGS=$(curl -s -H "Authorization: Bearer $TOKEN" \
https://tickup-api.mytickup.com/api/v1/team/projects/$PROJECT_ID/settings)
# Edit SETTINGS to add a new status, then:
curl -X PUT https://tickup-api.mytickup.com/api/v1/team/projects/$PROJECT_ID/settings \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d "$SETTINGS"
```
---
## Members
### Invite Member
```
POST /api/v1/team/projects/{projectId}/members/invite
```
**Request Body**
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `email` | string | Yes | Member's email address |
| `name` | string | No | Display name |
| `color` | string | No | Avatar colour, for example `"bg-blue-500"` |
---
### Remove Member
```
DELETE /api/v1/team/projects/{projectId}/members/{memberId}
```
---
## Tasks
### The Task Object
```json
{
"id": "25519dcf-eb1e-410a-8731-bc6aba541fb9",
"short_id": "TU-25519dcf",
"branch_name": "TU-25519dcf-fix-table-scroll",
"url": "https://app.mytickup.com/team/2df072bf-.../25519dcf-...",
"project_id": "2df072bf-...",
"parent_id": null,
"title": "Fix table scroll",
"description_html": "<p>Detailed description here.</p>",
"status": "in_progress",
"priority": "normal",
"created_by_user_id": "454df697-...",
"order_index": 0,
"custom_fields": { "sprint": "Sprint 1" },
"planned_duration": 0,
"tracked_duration": 3600,
"github": { "repoUrl": "https://github.com/...", "branchName": "TU-25519dcf-..." },
"created_at": "2026-05-22T15:11:19Z",
"updated_at": "2026-05-28T17:33:22Z",
"assignees": [
{ "id": "...", "name": "Lonny H", "initials": "LH", "color": "bg-violet-500" }
],
"comments": [],
"attachments": []
}
```
**Computed fields** (added by the Zaphiri API, not stored in the main DB):
| Field | Description |
|-------|-------------|
| `short_id` | `TU-` + first 8 chars of UUID, for example `TU-25519dcf` |
| `branch_name` | `TU-{shortId}-{slugified-title}`, for example `TU-25519dcf-fix-table-scroll` |
| `url` | Direct link to the task in the Zaphiri app |
**Priority values:** `low`, `normal`, `high`, `urgent`
**Status:** use the `name` field from the project settings statuses, for example `"In Review"` or `"Done"`
---
### List Tasks
```
GET /api/v1/team/projects/{projectId}/tasks
```
**Query Parameters**
| Parameter | Type | Description |
|-----------|------|-------------|
| `status` | string | Filter by status name |
| `assignee_id` | string (UUID) | Filter by assignee member ID |
| `limit` | integer | Number of tasks to return |
| `offset` | integer | Pagination offset |
**curl**
```bash
curl -H "Authorization: Bearer $TOKEN" \
"https://tickup-api.mytickup.com/api/v1/team/projects/$PROJECT_ID/tasks?status=in_progress"
```
---
### Create Task
```
POST /api/v1/team/projects/{projectId}/tasks
```
**Request Body**
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `title` | string | Yes | Task title |
| `description_html` | string | No | Task description (HTML or Markdown; see `format`) |
| `format` | string | No | `"html"` (default) or `"markdown"` |
| `status` | string | No | Status name from project settings |
| `priority` | string | No | `low`, `normal`, `high`, `urgent` |
| `assignee_ids` | array of UUIDs | No | Member IDs to assign |
| `parent_id` | string | No | UUID of a top-level task in the same project. Omit or set to `null` to create a top-level task. A subtask cannot be a parent. |
| `custom_fields` | object | No | Custom field values keyed by field ID |
**Response `201 Created`**
```json
{
"id": "98262dcd-eb1e-410a-8731-bc6aba541fb9",
"title": "Fix table scroll",
"status": "In Review",
"priority": "normal",
"project_id": "2df072bf-...",
"created_at": "2026-05-28T21:45:00Z",
"url": "https://app.mytickup.com/team/2df072bf-.../98262dcd-..."
}
```
**curl**
```bash
curl -X POST https://tickup-api.mytickup.com/api/v1/team/projects/$PROJECT_ID/tasks \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"title": "Fix table scroll",
"description_html": "## Problem\n\nTable overflows on mobile.",
"format": "markdown",
"status": "In Review",
"priority": "normal"
}'
```
**Hierarchy and validation**
Tasks support one level of subtasks: a top-level task may have multiple direct
children, but a child cannot contain further subtasks. The parent must be a live
top-level task in the same project. The same rule applies to
[[#Create Subtask|the dedicated subtask endpoint]].
For example, after creating a top-level task with `{"title":"Release checklist"}`
and receiving its UUID, create a direct child with:
```json
{
"title": "Review release notes",
"parent_id": "11111111-1111-4111-8111-111111111111"
}
```
Here `11111111-1111-4111-8111-111111111111` is the top-level task's UUID. Further
children may use that same UUID. Using a child's UUID instead returns
`400 Bad Request`:
```json
{
"error": "cannot create a subtask under another subtask"
}
```
The request is rejected rather than silently creating a top-level task or choosing
a different parent. Hierarchy validation is enforced by the authoritative Zaphiri
service, including when creation races a concurrent reparent. A rejected hierarchy
request creates no child task.
The project-create response above is a task summary and does not include
`parent_id`. Use [[#Get Task]] to inspect the persisted relationship.
| Status | Response `error` | When |
|--------|------------------|------|
| `400` | `cannot create a subtask under another subtask` | The proposed parent is itself a subtask, including deeper legacy nesting. |
| `400` | `parent task was not found in this project` | Parent validation cannot find a live parent in the requested project, including a missing, trashed or cross-project parent. |
| `401` | `unauthorized` | Authentication is rejected. |
| `403` | `forbidden - not a project member` | The upstream service denies access or the required create permission. |
| `404` | `not found` | A required resource is missing or inaccessible. The dedicated subtask endpoint can return this while looking up its target before creation. |
| `502` | `upstream TickUp API unavailable` | The upstream service is unavailable or returns a server error. |
Missing and inaccessible resources retain the normal access checks. Error messages
do not reveal another project's parent details.
---
### Get Task
```
GET /api/v1/team/tasks/{taskId}
```
---
### Update Task
Both `PUT` and `PATCH` are accepted. All fields are optional, so only include what you want to change.
```
PUT /api/v1/team/tasks/{taskId}
PATCH /api/v1/team/tasks/{taskId}
```
**Request Body**
| Field | Type | Description |
|-------|------|-------------|
| `title` | string | New title |
| `status` | string | New status name |
| `priority` | string | `low`, `normal`, `high`, `urgent` |
| `description_html` | string | Full replacement of description |
| `format` | string | `"html"` (default) or `"markdown"` |
| `assignee_ids` | array of UUIDs | Replaces current assignees |
| `custom_fields` | object | Custom field values to update |
| `planned_duration` | integer | Planned duration in seconds |
| `github` | object | `{ "repoUrl": "...", "branchName": "..." }` |
---
### Delete Task
```
DELETE /api/v1/team/tasks/{taskId}
```
---
### Append to Description
> [!tip] The safe way to add content
> The safest way to add content to a task without touching what's already there. It fetches the current description, strips trailing empty paragraphs, appends your content cleanly and saves it back.
```
POST /api/v1/team/tasks/{taskId}/append
```
**Request Body**
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `content` | string | Yes | Content to append |
| `format` | string | No | `"text"` (default), `"html"`, `"markdown"` |
| `heading` | string | No | Optional `<h3>` heading prepended to the appended block |
| `separator` | bool | No | If `true`, inserts a horizontal rule before the new content |
**Response**: same as GET task, with the updated `description_html`.
**Example: append a sprint review note**
Before:
```html
<h2>User Story</h2><p>As a user I want to...</p><ul><li>AC 1</li></ul>
```
Request:
```bash
curl -X POST https://tickup-api.mytickup.com/api/v1/team/tasks/$TASK_ID/append \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"content": "Completed sprint review. All ACs met. Shipped in PR #738.",
"format": "text",
"heading": "Sprint Review - 2026-05-28",
"separator": true
}'
```
After:
```html
<h2>User Story</h2><p>As a user I want to...</p><ul><li>AC 1</li></ul>
<hr><h3>Sprint Review - 2026-05-28</h3><p>Completed sprint review. All ACs met. Shipped in PR #738.</p>
```
**Format options**
| Format | Behaviour |
|--------|----------|
| `"text"` | Plain text. Double newlines become paragraph breaks, single newlines become `<br>`. HTML entities are escaped. |
| `"html"` | Raw HTML, passed through as is. |
| `"markdown"` | Converted to HTML (bold, italic, links, headings, lists, code blocks, tables). |
---
### Create Branch
Derives a git branch name from the task's short ID and title, saves it to the task's `github` field, and returns the ready-to-use `git checkout` command.
```
POST /api/v1/team/tasks/{taskId}/branch
```
**Request Body**
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `repo_url` | string | Yes | GitHub repo base URL (no trailing slash) |
| `repo_path` | string | No | Local path, returned for convenience only |
**Response `200 OK`**
```json
{
"branch_name": "TU-98262dcd-fix-table-scroll",
"repo_url": "https://github.com/your-org/your-repo",
"github_url": "https://github.com/your-org/your-repo/tree/TU-98262dcd-fix-table-scroll",
"git_command": "git checkout -b TU-98262dcd-fix-table-scroll",
"task_id": "98262dcd-eb1e-410a-8731-bc6aba541fb9"
}
```
**Branch naming:** `TU-{first-8-of-uuid}-{slugified-title}`: lowercase, spaces and special chars replaced with `-`, max 60 chars in the slug.
**curl**
```bash
curl -X POST https://tickup-api.mytickup.com/api/v1/team/tasks/$TASK_ID/branch \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"repo_url": "https://github.com/your-org/your-repo"}'
```
---
### Get Task Permalink
Returns a pre-built permalink for a task. This is useful for embedding task links in description HTML or comments without hardcoding the URL scheme.
```
GET /api/v1/team/tasks/{taskId}/permalink
```
**Response `200 OK`**
```json
{
"url": "/team/9d2b324b-b3fc-45b9-b5c8-c9c315c3bf79/25519dcf-eb1e-410a-8731-bc6aba541fb9",
"html": "<a href=\"/team/9d2b324b-.../25519dcf-...\" data-type=\"link\">Fix table scroll</a>",
"short_id": "TU-25519dcf",
"title": "Fix table scroll",
"status": "in_progress"
}
```
| Field | Description |
|-------|-------------|
| `url` | Relative URL to the task in the Zaphiri app |
| `html` | Ready-to-embed anchor tag compatible with Zaphiri's rich text editor (`data-type="link"` renders as a task pill) |
| `short_id` | Human-readable short ID, for example `TU-25519dcf` |
| `title` | Task title at time of request |
| `status` | Current status ID |
**Use case: link tasks in description_html**
Fetch permalinks for any tasks you want to cross-reference, then embed the `html` field directly in a `description_html` PATCH:
```bash
# Get permalink for the related task
LINK=$(curl -s $BASE/tasks/$OTHER_TASK_ID/permalink \
-H "Authorization: Bearer $TOKEN" | jq -r '.html')
# Embed it in a description update
curl -X PATCH $BASE/tasks/$TASK_ID \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d "{\"description_html\": \"<p>Related: $LINK</p>\"}"
```
**curl**
```bash
curl -H "Authorization: Bearer $TOKEN" \
https://tickup-api.mytickup.com/api/v1/team/tasks/$TASK_ID/permalink
```
---
## Subtasks
Subtasks are regular tasks with a `parent_id` set to a top-level task in the same
project. Only direct children are supported; subtasks cannot have their own subtasks.
### List Subtasks
```
GET /api/v1/team/tasks/{taskId}/subtasks
```
### Create Subtask
```
POST /api/v1/team/tasks/{taskId}/subtasks
```
Same request body as [[#Create Task]]; the URL's `taskId` selects the parent and
overrides any `parent_id` supplied in the body. The target must be a top-level task.
For example, post this body to
`/api/v1/team/tasks/11111111-1111-4111-8111-111111111111/subtasks`:
```json
{
"title": "Review release notes"
}
```
**Response `201 Created`** returns the full task object; the following excerpt
shows the new child's relationship:
```json
{
"id": "22222222-2222-4222-8222-222222222222",
"title": "Review release notes",
"project_id": "33333333-3333-4333-8333-333333333333",
"parent_id": "11111111-1111-4111-8111-111111111111"
}
```
Posting to a subtask's URL returns `400` with
`{"error":"cannot create a subtask under another subtask"}`. If the initial target
lookup fails, no create request is made: access/not-found errors are returned with
the normalised messages listed under [[#Create Task|Create Task validation]].
Validation can also reject a parent that changes between lookup and creation.
---
## Notes
Project Docs use the Team Notes CRUD endpoints under `/api/v1/team/notes` for create, list, update, delete and activity operations. This section covers references and version history.
### List Note References
Returns the tasks a note links to.
```
GET /api/v1/team/notes/{noteId}/references
```
**Response `200 OK`**
```json
[
{
"id": "task-1",
"title": "Referenced task",
"status": "open",
"priority": "medium",
"assignee": { "id": "...", "name": "...", "initials": "...", "color": "..." },
"inbound": false
}
]
```
`inbound: true` marks a back-reference: a task that links to this note, rather than a link the note itself created.
---
### Add Note Reference
```
POST /api/v1/team/notes/{noteId}/references
```
**Request Body**
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `task_id` | string | Yes | Task UUID to link to this note |
**Response:** `204 No Content`
---
### Remove Note Reference
```
DELETE /api/v1/team/notes/{noteId}/references/{refTaskId}
```
**Response:** `204 No Content`
---
### List Note Versions
```
GET /api/v1/team/notes/{noteId}/versions
```
**Response `200 OK`**
```json
[
{
"id": "ver-1",
"entity_id": "note-1",
"version_number": 3,
"title": "Note title",
"snippet": "some text...",
"created_at": "2026-08-10T12:00:00Z",
"author_name": "Ada",
"author_initials": "AL",
"author_color": "bg-blue-500"
}
]
```
The list keeps each version light, without `body_html`. Fetch a single version for the full content.
---
### Get Note Version
```
GET /api/v1/team/notes/{noteId}/versions/{versionId}
```
**Response `200 OK`**: the full version snapshot, including `body_html`.
---
### Restore Note Version
Restoring changes data, so it is registered as `POST`, never `GET`. Upstream snapshots the current content first, then re-applies the chosen version, so nothing is lost by restoring.
```
POST /api/v1/team/notes/{noteId}/versions/{versionId}/restore
```
**Response `200 OK`**: the restored note object.
---
## Comments
### Add Comment
```
POST /api/v1/team/tasks/{taskId}/comments
```
**Request Body**
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `body` | string | Yes | Comment content (HTML) |
| `format` | string | No | `"html"` (default) or `"markdown"` |
| `parent_id` | string | No | Parent comment UUID for threaded replies |
**curl**
```bash
curl -X POST https://tickup-api.mytickup.com/api/v1/team/tasks/$TASK_ID/comments \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"body": "<p>Looks good to merge.</p>"}'
```
---
### Update Comment
```
PUT /api/v1/team/comments/{commentId}
```
**Request Body:** `{ "body": "<p>Updated comment.</p>" }`
---
### Delete Comment
```
DELETE /api/v1/team/comments/{commentId}
```
---
## Attachments
Attachments use a two-step presign flow.
### Step 1: Presign Upload
```
POST /api/v1/team/tasks/{taskId}/attachments/presign
```
**Request Body**
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `filename` | string | Yes | File name |
| `size_bytes` | integer | Yes | File size in bytes |
| `content_type` | string | Yes | MIME type, for example `"image/png"` |
**Response**
```json
{
"upload_url": "https://tickup-prod-assets.s3.eu-north-1.amazonaws.com/user-uploads/...",
"key": "user-uploads/team/{projectId}/{taskId}/{uuid}-{filename}"
}
```
> [!important] Save the `key`
> The `key` value is the S3 object path. You must pass it as `url` in the Step 3 confirm call. It is **not** the same as `upload_url`.
### Step 2: Upload to S3
PUT the file directly to `upload_url` from Step 1. No auth headers are needed, because the URL is pre-signed.
```bash
curl -X PUT -H "Content-Type: image/png" \
--data-binary "@/path/to/file.png" \
"$UPLOAD_URL"
```
### Step 3: Confirm Attachment
```
POST /api/v1/team/tasks/{taskId}/attachments
```
**Request Body**
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `filename` | string | Yes | File name |
| `size_bytes` | integer | Yes | File size in bytes (must match Step 1) |
| `content_type` | string | Yes | MIME type |
| `url` | string | Yes | The `key` value returned by Step 1 (not the `upload_url`) |
**Full three-step example**
```bash
# Step 1 - presign
PRESIGN=$(curl -s -X POST $BASE/tasks/$TASK_ID/attachments/presign \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d "{\"filename\":\"screenshot.png\",\"size_bytes\":$(wc -c < file.png),\"content_type\":\"image/png\"}")
UPLOAD_URL=$(echo $PRESIGN | jq -r '.upload_url')
KEY=$(echo $PRESIGN | jq -r '.key')
# Step 2 - upload directly to S3
curl -X PUT -H "Content-Type: image/png" --data-binary "@file.png" "$UPLOAD_URL"
# Step 3 - confirm
curl -X POST $BASE/tasks/$TASK_ID/attachments \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d "{\"filename\":\"screenshot.png\",\"size_bytes\":$(wc -c < file.png),\"content_type\":\"image/png\",\"url\":\"$KEY\"}"
```
---
### Delete Attachment
```
DELETE /api/v1/team/attachments/{attachmentId}?task_id={taskId}&project_id={projectId}
```
Both `task_id` and `project_id` query parameters are required for authorisation. The attachment ID is returned in the task's `attachments` array.
```bash
curl -X DELETE \
"$BASE/attachments/$ATTACHMENT_ID?task_id=$TASK_ID&project_id=$PROJECT_ID" \
-H "Authorization: Bearer $TOKEN"
```
---
## Activity
### Get Task Activity
Returns the activity log for a task: status changes, assignments, comments and so on.
```
GET /api/v1/team/tasks/{taskId}/activity
```
**Response `200 OK`**
```json
[
{
"id": "...",
"task_id": "...",
"actor_member_id": "...",
"type": "status",
"detail": "changed status to In Progress",
"created_at": "2026-05-28T20:00:00Z"
}
]
```
---
## Notifications
### List Notifications
```
GET /api/v1/team/notifications
```
### Mark Notification Read
```
PUT /api/v1/team/notifications/{notificationId}
```
### Mark All Read
```
PUT /api/v1/team/notifications/read-all
```
---
## Error Reference
| Code | Cause |
|------|-------|
| `401` | Missing or invalid integration token, or integration is disabled |
| `403` | Authenticated account is not a member of the project |
| `404` | Task, project, comment or attachment not found |
| `501` | Endpoint not yet implemented in the main Zaphiri backend |
| `502` | Main Zaphiri API is unreachable |
---
## Common Workflows
### Weekly sprint review via CLI
```bash
TOKEN="your-integration-token"
TASK_ID="98262dcd-..."
BASE="https://tickup-api.mytickup.com/api/v1/team"
curl -X POST $BASE/tasks/$TASK_ID/append \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"content": "All ACs verified. Shipped in PR #738. No regressions.",
"format": "text",
"heading": "Sprint Review - 2026-05-28",
"separator": true
}'
```
### Start work on a task
```bash
# Get the branch name and git command
RESPONSE=$(curl -s -X POST $BASE/tasks/$TASK_ID/branch \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"repo_url": "https://github.com/your-org/your-repo"}')
echo $RESPONSE | jq -r '.git_command'
# git checkout -b TU-98262dcd-fix-table-scroll
# Move task to In Progress
curl -X PATCH $BASE/tasks/$TASK_ID \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"status": "In Progress"}'
```
---
**Back to:** [[API-Reference/API-Reference|API Reference]]