get_current_member | Get the member behind the API token: id (UUID), name, mention_name, role and workspace (url_slug, estimate_scale). |
get_epic | Get an epic by its numeric id (name, description, state, owners, dates, story stats). |
get_story | Get a story by its numeric id, with its description, workflow_state_id, owner_ids, estimate, labels, comments and its tasks (checklist items: id, description, complete, owner_ids). |
list_epics | List epics, paginated (page from 1, page_size 1-250, default 10); includes_description adds their descriptions. |
list_groups | List teams (API “groups”: id UUID, name, mention_name, member_ids, workflow_ids). archived true returns only archived teams, false only active ones. |
list_iterations | List iterations (id, name, status unstarted/started/done, start_date, end_date, group_ids). |
list_labels | List labels (id, name, color, archived, stats); slim true returns them without stats. |
list_members | List workspace members (id UUID, role, disabled, profile with name, mention_name and email). disabled true returns only disabled members, false only enabled ones. |
list_workflows | List workflows (id, name, default_state_id, team_id) with their states (id, name, type = category unstarted, started or finished): the source of workflow_state_id values. |
search_stories | Search stories with Shortcut search operators (AND between terms, plain words match title, description and comments). Operators: type:feature|bug|chore, state:“Ready for Dev”, is:unstarted|started|done, is:blocked, is:overdue, is:archived, owner:<mention_name>, requester:<mention_name>, team:“Team name”, epic:“Epic name”, label:“Label”, estimate:3, is:unestimated, id:123, title:”…”, description:”…”, comment:”…”, has:owner|epic|comment|task|label|deadline, dates created:|updated:|completed:|moved:|due: with YYYY-MM-DD, YYYY-MM-DD..YYYY-MM-DD, *..YYYY-MM-DD or today/yesterday; prefix ! or - to negate (!is:done). page_size 1-250; detail “slim” omits descriptions and comments (default “full”). Paging: the response “next” is a URL path — pass only the value of its “next” query parameter as next. |