Shortcut

Keep Shortcut in step with your workflows: create, update, find and delete stories, comment on them, manage their checklists and links, and plan the epics and iterations they belong to.

Actions

Action	What it does
Add comment	Comment on a story.
Add task	Add an item to a story's checklist.
Create epic	Add an epic: a larger piece of work that groups stories.
Create iteration	Add an iteration (a sprint) with its start and end dates.
Create story	Add a feature, bug or chore.
Delete epic	Permanently delete an epic.
Delete iteration	Permanently delete an iteration.
Delete story	Permanently delete a story with its tasks and comments.
Find stories	Search stories by text, or list the ones in a state, epic, iteration or team, or owned by someone.
Get epic	Read an epic with its state and progress: how many of its stories are done, started and not started.
Get story	Read a story with its state, owners, tasks and comments.
Link stories	Record that one story blocks, is blocked by, duplicates or relates to another.
Update epic	Move an epic to another state or change its details.
Update story	Move a story to another state, reassign it, or change its details.
Update task	Check off a task on a story's checklist, or change what it says or who's doing it.

Add comment

Comment on a story. Markdown and @mentions work.

Inputs

StorystorytextRequired: The story. Pick one, paste its link from Shortcut, or use one from an earlier step.
CommenttexttextRequired: The comment. Markdown and @mentions work.

Outputs

app_urltext: A link to the comment in Shortcut.
author_idtext: The id of the person who wrote it.
created_attext: When it was created (ISO 8601, UTC).
idnumber: The comment's id.
story_idnumber: The story it's on.
texttext: What the comment says.
updated_attext: When it last changed (ISO 8601, UTC).

Example output

{
  "app_url": "https://app.shortcut.com/acme/story/123#activity-2001",
  "author_id": "5f4bc6a1-0a1b-4b8e-9c3d-2e6f7a8b9c0d",
  "created_at": "2026-09-27T16:42:49Z",
  "id": 2001,
  "story_id": 123,
  "text": "Confirmed on Safari 18.",
  "updated_at": "2026-09-27T16:42:49Z"
}

Add task

Add an item to a story's checklist.

Inputs

StorystorytextRequired: The story. Pick one, paste its link from Shortcut, or use one from an earlier step.
TaskdescriptiontextRequired: What needs doing.
Ownersownerslist: Who's doing it.

Outputs

completetrue/false: Whether it's checked off.
completed_attext: When it was checked off.
created_attext: When it was created (ISO 8601, UTC).
descriptiontext: What the task says.
idnumber: The task's id, which Update task takes.
owner_idslist: The ids of the people it's assigned to.
positionnumber: Its place in the story's checklist.
story_idnumber: The story it's on.
updated_attext: When it last changed (ISO 8601, UTC).

Example output

{
  "complete": false,
  "completed_at": null,
  "created_at": "2026-09-27T16:42:49Z",
  "description": "Reproduce on Safari 18",
  "id": 1001,
  "owner_ids": [],
  "position": 1,
  "story_id": 123,
  "updated_at": "2026-09-27T16:42:49Z"
}

Create epic

Add an epic: a larger piece of work that groups stories.

Inputs

NamenametextRequired: The epic's name.
Descriptiondescriptiontext: What it's about. Markdown works.
Statestatetext: To Do, In Progress or Done, as your workspace names them.
Ownersownerslist: The people leading it.
Teamsteamslist: The teams working on it.
Requesterrequestertext: Who asked for it. Pick someone, or use an email address from an earlier step.
Labelslabelslist: Labels to put on the epic.
Planned start dateplanned_startdate: When work is planned to start.
Target datedeadlinedate: When it should be done.

Outputs

app_urltext: A link to the epic in Shortcut.
completedtrue/false: Whether it's done.
created_attext: When it was created (ISO 8601, UTC).
deadlinetext: Its target date.
descriptiontext: The epic's description (Markdown).
epic_state_idnumber: The id of the epic's state.
group_idslist: The ids of its teams.
idnumber: The epic's id.
labelslist: The labels on it.
nametext: The epic's name.
owner_idslist: The ids of its owners.
planned_start_datetext: When it's planned to start.
startedtrue/false: Whether work has started on it.
state_nametext: The name of the epic's state, e.g. In Progress.
statsobject: Progress across its stories.
updated_attext: When it last changed (ISO 8601, UTC).

Example output

{
  "app_url": "https://app.shortcut.com/acme/epic/45",
  "completed": false,
  "created_at": "2026-09-27T16:42:49Z",
  "deadline": "2026-12-18T12:00:00Z",
  "description": "Fix every checkout bug customers hit this quarter.",
  "epic_state_id": 500000003,
  "group_ids": [
    "61a4f2e0-3b5c-4d7e-8f90-1a2b3c4d5e6f"
  ],
  "id": 45,
  "labels": [],
  "name": "Checkout reliability",
  "owner_ids": [
    "5f4bc6a1-0a1b-4b8e-9c3d-2e6f7a8b9c0d"
  ],
  "planned_start_date": "2026-10-01T12:00:00Z",
  "started": true,
  "state_name": "In Progress",
  "stats": {
    "num_points": 21,
    "num_points_done": 8,
    "num_stories_done": 3,
    "num_stories_started": 2,
    "num_stories_total": 8,
    "num_stories_unstarted": 3
  },
  "updated_at": "2026-09-27T16:42:49Z"
}

Create iteration

Add an iteration (a sprint) with its start and end dates.

Inputs

NamenametextRequired: The iteration's name, e.g. Sprint 12.
Start datestart_datedateRequired: The first day.
End dateend_datedateRequired: The last day.
Descriptiondescriptiontext: Its goal or notes.
Teamsteamslist: The teams working on it.
Labelslabelslist: Labels to put on the iteration.

Outputs

app_urltext: A link to the iteration in Shortcut.
created_attext: When it was created (ISO 8601, UTC).
descriptiontext: The iteration's description.
end_datetext: The day it ends.
group_idslist: The ids of its teams.
idnumber: The iteration's id.
labelslist: The labels on it.
nametext: The iteration's name.
start_datetext: The day it starts.
statustext: unstarted, started or done.
updated_attext: When it last changed (ISO 8601, UTC).

Example output

{
  "app_url": "https://app.shortcut.com/acme/iteration/67",
  "created_at": "2026-09-27T16:42:49Z",
  "description": "Ship the checkout fixes.",
  "end_date": "2026-10-16",
  "group_ids": [],
  "id": 67,
  "labels": [],
  "name": "Sprint 12",
  "start_date": "2026-10-05",
  "status": "unstarted",
  "updated_at": "2026-09-27T16:42:49Z"
}

Create story

Add a feature, bug or chore. Only the name is needed; it lands where Shortcut puts new stories unless you pick a state.

Inputs

NamenametextRequired: The story's title.
Descriptiondescriptiontext: More detail. Markdown works.
Typestory_typetext: Feature, bug or chore.One of: feature, bug, chore.
Statestatetext: The workflow state. Leave empty to put it where Shortcut puts new stories (the team's default workflow, if you pick a team).
Teamteamtext: The team it belongs to.
Ownersownerslist: The people working on it.
Requesterrequestertext: Who asked for it. Pick someone, or use an email address from an earlier step.
Labelslabelslist: Labels to put on the story.
Epicepictext: The epic it belongs to.
Iterationiterationtext: The iteration (sprint) it's in.
Estimateestimatetext: Its point estimate, from your workspace's scale.
Due datedue_datedate: When it's due.
Custom fieldscustom_fieldsobject: Your workspace's custom fields, such as Priority or Severity. Type the value as Shortcut shows it, e.g. High. Fields left empty aren't changed.
Linkslinkslist: Web links to attach, such as a support ticket.

Outputs

app_urltext: A link to the story in Shortcut.
blockedtrue/false: Whether another story is blocking it.
commentslist: Its comments.
completedtrue/false: Whether it's done.
completed_attext: When it was completed.
created_attext: When it was created (ISO 8601, UTC).
deadlinetext: When it's due (ISO 8601, UTC).
descriptiontext: The story's description (Markdown).
epic_idnumber: The epic it belongs to.
estimatenumber: Its point estimate, if estimated.
external_linkslist: Web links attached to it.
group_idtext: The id of its team.
idnumber: The story's number (sc-123 is story 123).
iteration_idnumber: The iteration it's in.
labelslist: The labels on it.
nametext: The story's title.
owner_idslist: The ids of its owners.
requested_by_idtext: The id of the person who requested it.
startedtrue/false: Whether work has started on it.
started_attext: When it was started.
state_nametext: The name of the state it's in, e.g. In Development.
story_typetext: feature, bug or chore.
taskslist: Its checklist tasks.
updated_attext: When it last changed (ISO 8601, UTC).
workflow_state_idnumber: The id of the state it's in.

Example output

{
  "app_url": "https://app.shortcut.com/acme/story/123",
  "blocked": false,
  "comments": [],
  "completed": false,
  "created_at": "2026-09-27T16:42:49Z",
  "deadline": "2026-10-15T12:00:00Z",
  "description": "Reported by a customer through the support form.",
  "epic_id": 45,
  "estimate": 2,
  "external_links": [],
  "group_id": "61a4f2e0-3b5c-4d7e-8f90-1a2b3c4d5e6f",
  "id": 123,
  "iteration_id": 67,
  "labels": [
    {
      "id": 88,
      "name": "customer-reported"
    }
  ],
  "name": "Checkout button does nothing on Safari",
  "owner_ids": [
    "5f4bc6a1-0a1b-4b8e-9c3d-2e6f7a8b9c0d"
  ],
  "requested_by_id": "5f4bc6a1-0a1b-4b8e-9c3d-2e6f7a8b9c0d",
  "started": false,
  "state_name": "Ready for Development",
  "story_type": "bug",
  "tasks": [],
  "updated_at": "2026-09-27T16:42:49Z",
  "workflow_state_id": 500000008
}

Delete epic

Permanently delete an epic. Its stories are kept and just leave the epic. Deleting one that's already gone succeeds.

Inputs

EpicepictextRequired: The epic. Pick one, paste its link from Shortcut, or use one from an earlier step.

Outputs

already_deletedtrue/false: True if the epic had already been deleted.
deletedtrue/false: True once the epic is gone.
epic_idnumber: The epic that was deleted.

Example output

{
  "already_deleted": false,
  "deleted": true,
  "epic_id": 45
}

Delete iteration

Permanently delete an iteration. Its stories are kept and just leave the iteration. Deleting one that's already gone succeeds.

Inputs

IterationiterationtextRequired: The iteration. Pick one, paste its link from Shortcut, or use one from an earlier step.

Outputs

already_deletedtrue/false: True if the iteration had already been deleted.
deletedtrue/false: True once the iteration is gone.
iteration_idnumber: The iteration that was deleted.

Example output

{
  "already_deleted": false,
  "deleted": true,
  "iteration_id": 67
}

Delete story

Permanently delete a story with its tasks and comments. Deleting one that's already gone succeeds.

Inputs

StorystorytextRequired: The story. Pick one, paste its link from Shortcut, or use one from an earlier step.

Outputs

already_deletedtrue/false: True if the story had already been deleted.
deletedtrue/false: True once the story is gone.
story_idnumber: The story that was deleted.

Example output

{
  "already_deleted": false,
  "deleted": true,
  "story_id": 123
}

Find stories

Search stories by text, or list the ones in a state, epic, iteration or team, or owned by someone. Archived stories are left out.

Inputs

Search fortexttext: Words to search for, as in Shortcut's search box. Shortcut's search operators work too, e.g. is:blocked.
Statestatetext: The workflow state, e.g. In Development.
Typestory_typetext: Feature, bug or chore.One of: feature, bug, chore.
Ownerownertext: Only stories this person owns.
Teamteamtext: The team it belongs to.
Epicepictext: Only stories in this epic.
Iterationiterationtext: Only stories in this iteration.
Labellabeltext: Only stories with this label.
Changed sinceupdated_afterdate and time: Only stories changed after this moment.
Limitlimitnumber: How many to return, 1 to 250. Default 25.From 1 to 250.

Outputs

countnumber: How many stories were returned.
firstobject: The first story, or null if none matched.
storieslist: The matching stories, most recently changed first (or best match first for a text search).

Example output

{
  "count": 1,
  "first": {
    "app_url": "https://app.shortcut.com/acme/story/123",
    "blocked": false,
    "comments": [],
    "completed": false,
    "created_at": "2026-09-27T16:42:49Z",
    "deadline": "2026-10-15T12:00:00Z",
    "description": "Reported by a customer through the support form.",
    "epic_id": 45,
    "estimate": 2,
    "external_links": [],
    "group_id": "61a4f2e0-3b5c-4d7e-8f90-1a2b3c4d5e6f",
    "id": 123,
    "iteration_id": 67,
    "labels": [
      {
        "id": 88,
        "name": "customer-reported"
      }
    ],
    "name": "Checkout button does nothing on Safari",
    "owner_ids": [
      "5f4bc6a1-0a1b-4b8e-9c3d-2e6f7a8b9c0d"
    ],
    "requested_by_id": "5f4bc6a1-0a1b-4b8e-9c3d-2e6f7a8b9c0d",
    "started": false,
    "state_name": "Ready for Development",
    "story_type": "bug",
    "tasks": [],
    "updated_at": "2026-09-27T16:42:49Z",
    "workflow_state_id": 500000008
  },
  "stories": [
    {
      "app_url": "https://app.shortcut.com/acme/story/123",
      "blocked": false,
      "comments": [],
      "completed": false,
      "created_at": "2026-09-27T16:42:49Z",
      "deadline": "2026-10-15T12:00:00Z",
      "description": "Reported by a customer through the support form.",
      "epic_id": 45,
      "estimate": 2,
      "external_links": [],
      "group_id": "61a4f2e0-3b5c-4d7e-8f90-1a2b3c4d5e6f",
      "id": 123,
      "iteration_id": 67,
      "labels": [
        {
          "id": 88,
          "name": "customer-reported"
        }
      ],
      "name": "Checkout button does nothing on Safari",
      "owner_ids": [
        "5f4bc6a1-0a1b-4b8e-9c3d-2e6f7a8b9c0d"
      ],
      "requested_by_id": "5f4bc6a1-0a1b-4b8e-9c3d-2e6f7a8b9c0d",
      "started": false,
      "state_name": "Ready for Development",
      "story_type": "bug",
      "tasks": [],
      "updated_at": "2026-09-27T16:42:49Z",
      "workflow_state_id": 500000008
    }
  ]
}

Get epic

Read an epic with its state and progress: how many of its stories are done, started and not started.

Inputs

EpicepictextRequired: The epic. Pick one, paste its link from Shortcut, or use one from an earlier step.

Outputs

app_urltext: A link to the epic in Shortcut.
completedtrue/false: Whether it's done.
created_attext: When it was created (ISO 8601, UTC).
deadlinetext: Its target date.
descriptiontext: The epic's description (Markdown).
epic_state_idnumber: The id of the epic's state.
group_idslist: The ids of its teams.
idnumber: The epic's id.
labelslist: The labels on it.
nametext: The epic's name.
owner_idslist: The ids of its owners.
planned_start_datetext: When it's planned to start.
startedtrue/false: Whether work has started on it.
state_nametext: The name of the epic's state, e.g. In Progress.
statsobject: Progress across its stories.
updated_attext: When it last changed (ISO 8601, UTC).

Example output

{
  "app_url": "https://app.shortcut.com/acme/epic/45",
  "completed": false,
  "created_at": "2026-09-27T16:42:49Z",
  "deadline": "2026-12-18T12:00:00Z",
  "description": "Fix every checkout bug customers hit this quarter.",
  "epic_state_id": 500000003,
  "group_ids": [
    "61a4f2e0-3b5c-4d7e-8f90-1a2b3c4d5e6f"
  ],
  "id": 45,
  "labels": [],
  "name": "Checkout reliability",
  "owner_ids": [
    "5f4bc6a1-0a1b-4b8e-9c3d-2e6f7a8b9c0d"
  ],
  "planned_start_date": "2026-10-01T12:00:00Z",
  "started": true,
  "state_name": "In Progress",
  "stats": {
    "num_points": 21,
    "num_points_done": 8,
    "num_stories_done": 3,
    "num_stories_started": 2,
    "num_stories_total": 8,
    "num_stories_unstarted": 3
  },
  "updated_at": "2026-09-27T16:42:49Z"
}

Get story

Read a story with its state, owners, tasks and comments.

Inputs

StorystorytextRequired: The story. Pick one, paste its link from Shortcut, or use one from an earlier step.

Outputs

app_urltext: A link to the story in Shortcut.
blockedtrue/false: Whether another story is blocking it.
commentslist: Its comments.
completedtrue/false: Whether it's done.
completed_attext: When it was completed.
created_attext: When it was created (ISO 8601, UTC).
deadlinetext: When it's due (ISO 8601, UTC).
descriptiontext: The story's description (Markdown).
epic_idnumber: The epic it belongs to.
estimatenumber: Its point estimate, if estimated.
external_linkslist: Web links attached to it.
group_idtext: The id of its team.
idnumber: The story's number (sc-123 is story 123).
iteration_idnumber: The iteration it's in.
labelslist: The labels on it.
nametext: The story's title.
owner_idslist: The ids of its owners.
requested_by_idtext: The id of the person who requested it.
startedtrue/false: Whether work has started on it.
started_attext: When it was started.
state_nametext: The name of the state it's in, e.g. In Development.
story_typetext: feature, bug or chore.
taskslist: Its checklist tasks.
updated_attext: When it last changed (ISO 8601, UTC).
workflow_state_idnumber: The id of the state it's in.

Example output

{
  "app_url": "https://app.shortcut.com/acme/story/123",
  "blocked": false,
  "comments": [],
  "completed": false,
  "created_at": "2026-09-27T16:42:49Z",
  "deadline": "2026-10-15T12:00:00Z",
  "description": "Reported by a customer through the support form.",
  "epic_id": 45,
  "estimate": 2,
  "external_links": [],
  "group_id": "61a4f2e0-3b5c-4d7e-8f90-1a2b3c4d5e6f",
  "id": 123,
  "iteration_id": 67,
  "labels": [
    {
      "id": 88,
      "name": "customer-reported"
    }
  ],
  "name": "Checkout button does nothing on Safari",
  "owner_ids": [
    "5f4bc6a1-0a1b-4b8e-9c3d-2e6f7a8b9c0d"
  ],
  "requested_by_id": "5f4bc6a1-0a1b-4b8e-9c3d-2e6f7a8b9c0d",
  "started": false,
  "state_name": "Ready for Development",
  "story_type": "bug",
  "tasks": [],
  "updated_at": "2026-09-27T16:42:49Z",
  "workflow_state_id": 500000008
}

Link stories

Record that one story blocks, is blocked by, duplicates or relates to another.

Inputs

StorystorytextRequired: The story. Pick one, paste its link from Shortcut, or use one from an earlier step.
RelationshiprelationshiptextRequired: Read it as a sentence: this story blocks the other story.One of: blocks, blocked_by (Is blocked by), duplicates, relates_to (Relates to).
Other storyother_storytextRequired: The other story. Pick one, paste its link, or use one from an earlier step.

Outputs

created_attext: When it was created (ISO 8601, UTC).
idnumber: The link's id.
object_idnumber: The other story.
subject_idnumber: The story that blocks, duplicates or relates to the other.
updated_attext: When it last changed (ISO 8601, UTC).
verbtext: blocks, duplicates or relates to.

Example output

{
  "created_at": "2026-09-27T16:42:49Z",
  "id": 3001,
  "object_id": 124,
  "subject_id": 123,
  "updated_at": "2026-09-27T16:42:49Z",
  "verb": "blocks"
}

Update epic

Move an epic to another state or change its details. Only the fields you fill in change.

Inputs

EpicepictextRequired: The epic. Pick one, paste its link from Shortcut, or use one from an earlier step.
Namenametext: The epic's name.
Descriptiondescriptiontext: What it's about. Markdown works.
Statestatetext: To Do, In Progress or Done, as your workspace names them.
Ownersownerslist: The people leading it. Replaces the epic's current owners.
Teamsteamslist: The teams working on it.
Requesterrequestertext: Who asked for it. Pick someone, or use an email address from an earlier step.
Add labelsadd_labelslist: Labels to add. The epic's existing labels are kept.
Planned start dateplanned_startdate: When work is planned to start.
Target datedeadlinedate: When it should be done.

Outputs

app_urltext: A link to the epic in Shortcut.
completedtrue/false: Whether it's done.
created_attext: When it was created (ISO 8601, UTC).
deadlinetext: Its target date.
descriptiontext: The epic's description (Markdown).
epic_state_idnumber: The id of the epic's state.
group_idslist: The ids of its teams.
idnumber: The epic's id.
labelslist: The labels on it.
nametext: The epic's name.
owner_idslist: The ids of its owners.
planned_start_datetext: When it's planned to start.
startedtrue/false: Whether work has started on it.
state_nametext: The name of the epic's state, e.g. In Progress.
statsobject: Progress across its stories.
updated_attext: When it last changed (ISO 8601, UTC).

Example output

{
  "app_url": "https://app.shortcut.com/acme/epic/45",
  "completed": false,
  "created_at": "2026-09-27T16:42:49Z",
  "deadline": "2026-12-18T12:00:00Z",
  "description": "Fix every checkout bug customers hit this quarter.",
  "epic_state_id": 500000003,
  "group_ids": [
    "61a4f2e0-3b5c-4d7e-8f90-1a2b3c4d5e6f"
  ],
  "id": 45,
  "labels": [],
  "name": "Checkout reliability",
  "owner_ids": [
    "5f4bc6a1-0a1b-4b8e-9c3d-2e6f7a8b9c0d"
  ],
  "planned_start_date": "2026-10-01T12:00:00Z",
  "started": true,
  "state_name": "In Progress",
  "stats": {
    "num_points": 21,
    "num_points_done": 8,
    "num_stories_done": 3,
    "num_stories_started": 2,
    "num_stories_total": 8,
    "num_stories_unstarted": 3
  },
  "updated_at": "2026-09-27T16:42:49Z"
}

Update story

Move a story to another state, reassign it, or change its details. Only the fields you fill in change.

Inputs

StorystorytextRequired: The story. Pick one, paste its link from Shortcut, or use one from an earlier step.
Namenametext: The story's title.
Descriptiondescriptiontext: More detail. Markdown works.
Typestory_typetext: Feature, bug or chore.One of: feature, bug, chore.
Statestatetext: The workflow state, e.g. In Development.
Teamteamtext: The team it belongs to.
Ownersownerslist: The people working on it. Replaces the story's current owners.
Requesterrequestertext: Who asked for it. Pick someone, or use an email address from an earlier step.
Add labelsadd_labelslist: Labels to add. The story's existing labels are kept.
Epicepictext: The epic it belongs to.
Iterationiterationtext: The iteration (sprint) it's in.
Estimateestimatetext: Its point estimate, from your workspace's scale.
Due datedue_datedate: When it's due.
Custom fieldscustom_fieldsobject: Your workspace's custom fields, such as Priority or Severity. Type the value as Shortcut shows it, e.g. High. Fields left empty aren't changed.
Linkslinkslist: Web links to add. The story's existing links are kept.

Outputs

app_urltext: A link to the story in Shortcut.
blockedtrue/false: Whether another story is blocking it.
commentslist: Its comments.
completedtrue/false: Whether it's done.
completed_attext: When it was completed.
created_attext: When it was created (ISO 8601, UTC).
deadlinetext: When it's due (ISO 8601, UTC).
descriptiontext: The story's description (Markdown).
epic_idnumber: The epic it belongs to.
estimatenumber: Its point estimate, if estimated.
external_linkslist: Web links attached to it.
group_idtext: The id of its team.
idnumber: The story's number (sc-123 is story 123).
iteration_idnumber: The iteration it's in.
labelslist: The labels on it.
nametext: The story's title.
owner_idslist: The ids of its owners.
requested_by_idtext: The id of the person who requested it.
startedtrue/false: Whether work has started on it.
started_attext: When it was started.
state_nametext: The name of the state it's in, e.g. In Development.
story_typetext: feature, bug or chore.
taskslist: Its checklist tasks.
updated_attext: When it last changed (ISO 8601, UTC).
workflow_state_idnumber: The id of the state it's in.

Example output

{
  "app_url": "https://app.shortcut.com/acme/story/123",
  "blocked": false,
  "comments": [],
  "completed": false,
  "created_at": "2026-09-27T16:42:49Z",
  "deadline": "2026-10-15T12:00:00Z",
  "description": "Reported by a customer through the support form.",
  "epic_id": 45,
  "estimate": 2,
  "external_links": [],
  "group_id": "61a4f2e0-3b5c-4d7e-8f90-1a2b3c4d5e6f",
  "id": 123,
  "iteration_id": 67,
  "labels": [
    {
      "id": 88,
      "name": "customer-reported"
    }
  ],
  "name": "Checkout button does nothing on Safari",
  "owner_ids": [
    "5f4bc6a1-0a1b-4b8e-9c3d-2e6f7a8b9c0d"
  ],
  "requested_by_id": "5f4bc6a1-0a1b-4b8e-9c3d-2e6f7a8b9c0d",
  "started": false,
  "state_name": "Ready for Development",
  "story_type": "bug",
  "tasks": [],
  "updated_at": "2026-09-27T16:42:49Z",
  "workflow_state_id": 500000008
}

Update task

Check off a task on a story's checklist, or change what it says or who's doing it.

Inputs

StorystorytextRequired: The story. Pick one, paste its link from Shortcut, or use one from an earlier step.
TasktasktextRequired: The task. Pick one, or use a task id from an earlier step.
Statusstatustext: Check it off, or uncheck it.One of: done, not_done (Not done).
Task textdescriptiontext: New wording for the task.
Ownersownerslist: Who's doing it. Replaces the task's current owners.

Outputs

completetrue/false: Whether it's checked off.
completed_attext: When it was checked off.
created_attext: When it was created (ISO 8601, UTC).
descriptiontext: What the task says.
idnumber: The task's id, which Update task takes.
owner_idslist: The ids of the people it's assigned to.
positionnumber: Its place in the story's checklist.
story_idnumber: The story it's on.
updated_attext: When it last changed (ISO 8601, UTC).

Example output

{
  "complete": true,
  "completed_at": "2026-09-28T09:00:00Z",
  "created_at": "2026-09-27T16:42:49Z",
  "description": "Reproduce on Safari 18",
  "id": 1001,
  "owner_ids": [],
  "position": 1,
  "story_id": 123,
  "updated_at": "2026-09-27T16:42:49Z"
}

ActionsCopy Anchor Link

Add commentCopy Anchor Link

Inputs

Outputs

Add taskCopy Anchor Link

Inputs

Outputs

Create epicCopy Anchor Link

Inputs

Outputs

Create iterationCopy Anchor Link

Inputs

Outputs

Create storyCopy Anchor Link

Inputs

Outputs

Delete epicCopy Anchor Link

Inputs

Outputs

Delete iterationCopy Anchor Link

Inputs

Outputs

Delete storyCopy Anchor Link

Inputs

Outputs

Find storiesCopy Anchor Link

Inputs

Outputs

Get epicCopy Anchor Link

Inputs

Outputs

Get storyCopy Anchor Link

Inputs

Outputs

Link storiesCopy Anchor Link

Inputs

Outputs

Update epicCopy Anchor Link

Inputs

Outputs

Update storyCopy Anchor Link

Inputs

Outputs

Update taskCopy Anchor Link

Inputs

Outputs

On this page

Actions

Add comment

Add task

Create epic

Create iteration

Create story

Delete epic

Delete iteration

Delete story

Find stories

Get epic

Get story

Link stories

Update epic

Update story

Update task