Optional
abbreviationThe Project abbreviation used in Story summaries. Should be kept to 3 characters at most.
The Shortcut application url for the Project.
True/false boolean indicating whether the Project is in an Archived state.
Optional
colorThe color associated with the Project in the Shortcut member interface.
css-color
1
^#[a-fA-F0-9]{6}$
Optional
created_The time/date that the Project was created.
date-time
The number of days before the thermometer appears in the Story summary.
int64
Optional
descriptionThe description of the Project.
A string description of this resource.
Optional
external_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.
An array of UUIDs for any Members listed as Followers.
The Global ID of the Project.
The unique ID of the Project.
int64
The number of weeks per iteration in this Project.
int64
The name of the Project
Configuration to enable or disable thermometers in the Story summary.
The date at which the Project was started.
date-time
A group of calculated values for this Project.
The ID of the team the project belongs to.
int64
Optional
updated_The time/date that the Project was last updated.
date-time
The ID of the workflow the project belongs to.
int64
Generated using TypeDoc
Projects typically map to teams (such as Frontend, Backend, Mobile, Devops, etc) but can represent any open-ended product, component, or initiative.