Interface Project

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

Hierarchy

  • Project

Properties

abbreviation?: 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?: string

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

Format

css-color

Min Length

1

Pattern

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

created_at?: string

The time/date that the Project was created.

Format

date-time

days_to_thermometer: number

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

Format

int64

description?: string

The description of the Project.

entity_type: string

A string description of this resource.

external_id?: 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.

Format

int64

iteration_length: number

The number of weeks per iteration in this Project.

Format

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.

Format

date-time

A group of calculated values for this Project.

team_id: number

The ID of the team the project belongs to.

Format

int64

updated_at?: string

The time/date that the Project was last updated.

Format

date-time

workflow_id: number

The ID of the workflow the project belongs to.

Format

int64

Generated using TypeDoc