Interface Project

Details about a project.

interface Project {
    archived?: boolean;
    archivedBy?: User;
    archivedDate?: string;
    assigneeType?: "PROJECT_LEAD" | "UNASSIGNED";
    avatarUrls?: AvatarUrlsBean;
    components?: ProjectComponent[];
    deleted?: boolean;
    deletedBy?: User;
    deletedDate?: string;
    description?: string;
    email?: string;
    expand?: string;
    favourite?: boolean;
    id?: string;
    insight?: ProjectInsight;
    isPrivate?: boolean;
    issueTypeHierarchy?: Hierarchy;
    issueTypes?: IssueTypeDetails[];
    key?: string;
    landingPageInfo?: ProjectLandingPageInfo;
    lead?: User;
    name?: string;
    permissions?: ProjectPermissions;
    projectCategory?: ProjectCategory;
    projectTypeKey?:
        | "software"
        | "service_desk"
        | "product_discovery"
        | "business";
    properties?: {
        [key: string]: unknown;
    };
    retentionTillDate?: string;
    roles?: {
        [key: string]: string;
    };
    self?: string;
    simplified?: boolean;
    style?: "classic" | "next-gen";
    url?: string;
    uuid?: string;
    versions?: Version[];
}

Properties

archived? archivedBy? archivedDate? assigneeType? avatarUrls? components? deleted? deletedBy? deletedDate? description? email? expand? favourite? id? insight? isPrivate? issueTypeHierarchy? issueTypes? key? landingPageInfo? lead? name? permissions? projectCategory? projectTypeKey? properties? retentionTillDate? roles? self? simplified? style? url? uuid? versions?

Properties

Optionalarchived

archived?: boolean

Whether the project is archived.

OptionalarchivedBy

archivedBy?: User

The user who archived the project.

OptionalarchivedDate

archivedDate?: string

The date when the project was archived.

OptionalassigneeType

assigneeType?: "PROJECT_LEAD" | "UNASSIGNED"

The default assignee when creating issues for this project.

OptionalavatarUrls

avatarUrls?: AvatarUrlsBean

The URLs of the project's avatars.

Optionalcomponents

components?: ProjectComponent[]

List of the components contained in the project.

Optionaldeleted

deleted?: boolean

Whether the project is marked as deleted.

OptionaldeletedBy

deletedBy?: User

The user who marked the project as deleted.

OptionaldeletedDate

deletedDate?: string

The date when the project was marked as deleted.

Optionaldescription

description?: string

A brief description of the project.

Optionalemail

email?: string

An email address associated with the project.

Optionalexpand

expand?: string

Expand options that include additional project details in the response.

Optionalfavourite

favourite?: boolean

Whether the project is selected as a favorite.

Optionalid

id?: string

The ID of the project.

Optionalinsight

insight?: ProjectInsight

Insights about the project.

OptionalisPrivate

isPrivate?: boolean

Whether the project is private from the user's perspective. This means the user can't see the project or any associated issues.

OptionalissueTypeHierarchy

issueTypeHierarchy?: Hierarchy

The issue type hierarchy for the project.

OptionalissueTypes

issueTypes?: IssueTypeDetails[]

List of the issue types available in the project.

Optionalkey

key?: string

The key of the project.

OptionallandingPageInfo

landingPageInfo?: ProjectLandingPageInfo

The project landing page info.

Optionallead

lead?: User

The username of the project lead.

Optionalname

name?: string

The name of the project.

Optionalpermissions

permissions?: ProjectPermissions

User permissions on the project

OptionalprojectCategory

projectCategory?: ProjectCategory

The category the project belongs to.

OptionalprojectTypeKey

projectTypeKey?:
    | "software"
    | "service_desk"
    | "product_discovery"
    | "business"

The project type of the project.

Optionalproperties

properties?: {
    [key: string]: unknown;
}

Map of project properties

OptionalretentionTillDate

retentionTillDate?: string

The date when the project is deleted permanently.

Optionalroles

roles?: {
    [key: string]: string;
}

The name and self URL for each role defined in the project. For more information, see Create project role.

Optionalself

self?: string

The URL of the project details.

Optionalsimplified

simplified?: boolean

Whether the project is simplified.

Optionalstyle

style?: "classic" | "next-gen"

The type of the project.

Optionalurl

url?: string

A link to information about this project, such as project documentation.

Optionaluuid

uuid?: string

Unique ID for next-gen projects.

Optionalversions

versions?: Version[]

The versions defined in the project. For more information, see Create version.

Settings

Member Visibility

On This Page

Properties