@shortcut/client
    Preparing search index...

    Interface StorySlim

    StorySlim represents the same resource as a Story, but is more light-weight. For certain fields it provides ids rather than full resources (e.g., comment_ids and file_ids) and it also excludes certain aggregate values (e.g., cycle_time). The description field can be optionally included. Use the Get Story endpoint to fetch the unabridged payload for a Story.

    interface StorySlim {
        app_url: string;
        archived: boolean;
        blocked: boolean;
        blocker: boolean;
        comment_ids: number[];
        completed: boolean;
        completed_at?: null | string;
        completed_at_override?: null | string;
        created_at: string;
        custom_fields?: StoryCustomField[];
        cycle_time?: number;
        deadline?: null | string;
        description?: string;
        entity_type: string;
        epic_id?: null | number;
        estimate?: null | number;
        external_id?: null | string;
        external_links: string[];
        file_ids: number[];
        follower_ids: string[];
        formatted_vcs_branch_name?: null | string;
        global_id: string;
        group_id?: null | string;
        group_mention_ids: string[];
        id: number;
        iteration_id?: null | number;
        label_ids: number[];
        labels: LabelSlim[];
        lead_time?: number;
        linked_file_ids: number[];
        member_mention_ids: string[];
        mention_ids: string[];
        moved_at?: null | string;
        name: string;
        num_tasks_completed: number;
        owner_ids: string[];
        parent_story_id?: null | number;
        position: number;
        previous_iteration_ids: number[];
        project_id?: null | number;
        requested_by_id: string;
        started: boolean;
        started_at?: null | string;
        started_at_override?: null | string;
        stats: StoryStats;
        story_links: TypedStoryLink[];
        story_template_id?: null | string;
        story_type: string;
        sub_task_story_ids?: number[];
        synced_item?: SyncedItem;
        task_ids: number[];
        updated_at?: null | string;
        workflow_id: number;
        workflow_state_id: number;
    }
    Index

    Properties

    app_url: string

    The Shortcut application url for the Story.

    archived: boolean

    True if the story has been archived or not.

    blocked: boolean

    A true/false boolean indicating if the Story is currently blocked.

    blocker: boolean

    A true/false boolean indicating if the Story is currently a blocker of another story.

    comment_ids: number[]

    An array of IDs of Comments attached to the story.

    completed: boolean

    A true/false boolean indicating if the Story has been completed.

    completed_at?: null | string

    The time/date the Story was completed.

    date-time

    completed_at_override?: null | string

    A manual override for the time/date the Story was completed.

    date-time

    created_at: string

    The time/date the Story was created.

    date-time

    custom_fields?: StoryCustomField[]

    An array of CustomField value assertions for the story.

    cycle_time?: number

    The cycle time (in seconds) of this story when complete.

    int64

    deadline?: null | string

    The due date of the story.

    date-time

    description?: string

    The description of the Story.

    entity_type: string

    A string description of this resource.

    epic_id?: null | number

    The ID of the epic the story belongs to.

    int64

    estimate?: null | number

    The numeric point estimate of the story. Can also be null, which means unestimated.

    int64

    external_id?: null | string

    This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.

    external_links: string[]

    An array of external links (strings) associated with a Story

    file_ids: number[]

    An array of IDs of Files attached to the story.

    follower_ids: string[]

    An array of UUIDs for any Members listed as Followers.

    formatted_vcs_branch_name?: null | string

    The formatted branch name for this story.

    global_id: string
    group_id?: null | string

    The ID of the group associated with the story.

    uuid

    group_mention_ids: string[]

    An array of Group IDs that have been mentioned in the Story description.

    id: number

    The unique ID of the Story.

    int64

    iteration_id?: null | number

    The ID of the iteration the story belongs to.

    int64

    label_ids: number[]

    An array of label ids attached to the story.

    labels: LabelSlim[]

    An array of labels attached to the story.

    lead_time?: number

    The lead time (in seconds) of this story when complete.

    int64

    linked_file_ids: number[]

    An array of IDs of LinkedFiles attached to the story.

    member_mention_ids: string[]

    An array of Member IDs that have been mentioned in the Story description.

    mention_ids: string[]

    Deprecated: use member_mention_ids.

    moved_at?: null | string

    The time/date the Story was last changed workflow-state.

    date-time

    name: string

    The name of the story.

    num_tasks_completed: number

    The number of tasks on the story which are complete.

    int64

    owner_ids: string[]

    An array of UUIDs of the owners of this story.

    Optionalparent_story_id

    parent_story_id?: null | number

    int64

    position: number

    A number representing the position of the story in relation to every other story in the current project.

    int64

    previous_iteration_ids: number[]

    The IDs of the iteration the story belongs to.

    project_id?: null | number

    The ID of the project the story belongs to.

    int64

    requested_by_id: string

    The ID of the Member that requested the story.

    uuid

    started: boolean

    A true/false boolean indicating if the Story has been started.

    started_at?: null | string

    The time/date the Story was started.

    date-time

    started_at_override?: null | string

    A manual override for the time/date the Story was started.

    date-time

    stats: StoryStats

    The stats object for Stories

    story_links

    story_links: TypedStoryLink[]

    An array of story links attached to the Story.

    Optionalstory_template_id

    story_template_id?: null | string

    The ID of the story template used to create this story, or null if not created using a template.

    uuid

    story_type

    story_type: string

    The type of story (feature, bug, chore).

    Optionalsub_task_story_ids

    sub_task_story_ids?: number[]
    synced_item?: SyncedItem

    The synced item for the story.

    task_ids: number[]

    An array of IDs of Tasks attached to the story.

    updated_at?: null | string

    The time/date the Story was updated.

    date-time

    workflow_id: number

    The ID of the workflow the story belongs to.

    int64

    workflow_state_id: number

    The ID of the workflow state the story is currently in.

    int64