@shortcut/client
    Preparing search index...

    Interface Project

    Projects typically map to teams (such as Frontend, Backend, Mobile, Devops, etc) but can represent any open-ended product, component, or initiative.

    interface Project {
        abbreviation?: null | string;
        app_url: string;
        archived: boolean;
        color?: null | string;
        created_at?: null | string;
        days_to_thermometer: number;
        description?: null | string;
        entity_type: string;
        external_id?: null | string;
        follower_ids: string[];
        global_id: string;
        id: number;
        iteration_length: number;
        name: string;
        show_thermometer: boolean;
        start_time: string;
        stats: ProjectStats;
        team_id: number;
        updated_at?: null | string;
        workflow_id: number;
    }
    Index

    Properties

    abbreviation? app_url archived color? created_at? days_to_thermometer description? entity_type external_id? follower_ids global_id id iteration_length name show_thermometer start_time stats team_id updated_at? workflow_id

    Properties

    abbreviation?: null | string

    The Project abbreviation used in Story summaries. Should be kept to 3 characters at most.

    app_url: string

    The Shortcut application url for the Project.

    archived: boolean

    True/false boolean indicating whether the Project is in an Archived state.

    color?: null | string

    The color associated with the Project in the Shortcut member interface.

    css-color

    1

    ^#[a-fA-F0-9]{6}$

    created_at?: null | string

    The time/date that the Project was created.

    date-time

    days_to_thermometer: number

    The number of days before the thermometer appears in the Story summary.

    int64

    description?: null | string

    The description of the Project.

    entity_type: string

    A string description of this resource.

    external_id?: null | string

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

    follower_ids: string[]

    An array of UUIDs for any Members listed as Followers.

    global_id: string

    The Global ID of the Project.

    id: number

    The unique ID of the Project.

    int64

    iteration_length: number

    The number of weeks per iteration in this Project.

    int64

    name: string

    The name of the Project

    show_thermometer: boolean

    Configuration to enable or disable thermometers in the Story summary.

    start_time: string

    The date at which the Project was started.

    date-time

    stats: ProjectStats

    A group of calculated values for this Project.

    team_id: number

    The ID of the team the project belongs to.

    int64

    updated_at?: null | string

    The time/date that the Project was last updated.

    date-time

    workflow_id: number

    The ID of the workflow the project belongs to.

    int64

    Settings

    Member Visibility

    On This Page

    Properties