@shortcut/client
    Preparing search index...

    Interface Story

    interface Story {
        app_url?: string;
        archived?: boolean;
        blocked?: boolean;
        blocker?: boolean;
        branches?: NestedBranchSlimList;
        checklist_items?: NestedChecklistItemSlimList;
        comments?: NestedCommentSlimList;
        commits?: NestedCommitSlimList;
        completed?: boolean;
        completed_at?: string | null;
        completed_at_override?: string | null;
        created_at?: string;
        custom_field_values?: NestedCustomFieldValueSlimList;
        deadline?: string | null;
        description?: string;
        entity_type?: "story";
        epic?: EpicSlim | null;
        estimate?: number | null;
        external_id?: string | null;
        external_links?: NestedExternalLinkList;
        files?: NestedFileSlimList;
        followers?: NestedMemberSlimList;
        id?: number;
        iterations?: NestedIterationSlimList;
        labels?: NestedLabelSlimList;
        linked_files?: NestedLinkedFileSlimList;
        mentioned_members?: NestedMemberSlimList;
        mentioned_teams?: NestedTeamSlimList;
        moved_at?: string | null;
        name?: string;
        owners?: NestedMemberSlimList;
        parent_story?: StorySlim | null;
        position?: number;
        project?: ProjectSlim | null;
        pull_requests?: NestedPullRequestSlimList;
        requester?: MemberSlim;
        started?: boolean;
        started_at?: string | null;
        started_at_override?: string | null;
        story_links?: NestedStoryLinkSlimList;
        story_template?: StoryTemplateSlim | null;
        story_type?: "feature" | "chore" | "bug";
        sub_task_stories?: NestedStorySlimList;
        team?: TeamSlim | null;
        updated_at?: string;
        uri?: string;
        workflow?: WorkflowSlim;
        workflow_state?: WorkflowStateSlim;
    }
    Index

    Properties

    app_url? archived? blocked? blocker? branches? checklist_items? comments? commits? completed? completed_at? completed_at_override? created_at? custom_field_values? deadline? description? entity_type? epic? estimate? external_id? external_links? files? followers? id? iterations? labels? linked_files? mentioned_members? mentioned_teams? moved_at? name? owners? parent_story? position? project? pull_requests? requester? started? started_at? started_at_override? story_links? story_template? story_type? sub_task_stories? team? updated_at? uri? workflow? workflow_state?

    Properties

    app_url?: string

    The Shortcut application url for the Story.

    2048

    ^https?://.+$

    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.

    branches?: NestedBranchSlimList

    A list of Git branches attached to the Story.

    checklist_items?: NestedChecklistItemSlimList

    A list of Checklist Items attached to the Story.

    comments?: NestedCommentSlimList

    A list of comments attached to the Story.

    commits?: NestedCommitSlimList

    A list of commits attached to the Story.

    completed?: boolean

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

    completed_at?: string | null

    The time/date the Story was completed.

    date-time

    completed_at_override?: string | null

    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_field_values?: NestedCustomFieldValueSlimList

    A list of Custom Field values for the Story.

    deadline?: string | null

    The Story's deadline.

    date-time

    description?: string

    The description of the Story.

    entity_type?: "story"

    The type of this entity.

    epic?: EpicSlim | null

    The Epic the story belongs to.

    estimate?: number | null

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

    int64

    external_id?: string | null

    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?: NestedExternalLinkList

    A list of external links connected to the Story.

    files?: NestedFileSlimList

    A list of files attached to the Story.

    followers?: NestedMemberSlimList

    The Members who followers of the Doc.

    id?: number

    The unique ID of the Story.

    int64

    iterations?: NestedIterationSlimList

    A list of Iterations that this Story has been attached to.

    labels?: NestedLabelSlimList

    A list of labels attached to the Story.

    linked_files?: NestedLinkedFileSlimList

    A list of linked files attached to the Story.

    mentioned_members?: NestedMemberSlimList

    The Members who followers of the Doc.

    mentioned_teams?: NestedTeamSlimList

    A list of Teams that this Member belongs to.

    moved_at?: string | null

    The time this Story was last moved between Workflow States.

    date-time

    name?: string

    The name of the Story.

    owners?: NestedMemberSlimList

    The Members who followers of the Doc.

    Optionalparent_story

    parent_story?: StorySlim | null

    The Story this Checklist Item belongs to.

    position?: number

    The Story's relative position.

    int64

    project?: ProjectSlim | null

    The Project the story belongs to.

    pull_requests?: NestedPullRequestSlimList

    A list of Pull/Merge Requests attached to the Story.

    requester?: MemberSlim

    The Member who created the Doc.

    started?: boolean

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

    started_at?: string | null

    The time/date the Story was started.

    date-time

    started_at_override?: string | null

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

    date-time

    Optionalstory_links

    story_links?: NestedStoryLinkSlimList

    A list of Story links attached to the Story.

    Optionalstory_template

    story_template?: StoryTemplateSlim | null

    Optionalstory_type

    story_type?: "feature" | "chore" | "bug"

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

    sub_task_stories?: NestedStorySlimList

    A list of Stories associated with this Project.

    team?: TeamSlim | null
    updated_at?: string

    The time/date the Story was updated.

    date-time

    uri?: string

    A resolvable URI for the entity that will return the full representation.

    2048

    ^https?://.+$

    workflow?: WorkflowSlim

    The default Workflow for the Workspace the caller is authenticated against.

    workflow_state?: WorkflowStateSlim

    The default Workflow State of the Workspace's default Workflow.

    Settings

    Member Visibility

    On This Page

    Properties