jira.js
    Preparing search index...

    Function getProject

    • Returns the project details for a project.

      This operation can be accessed anonymously.

      Permissions required: Browse projects project permission for the project.

      Parameters

      • client: Client
      • parameters: {
            expand?:
                | string
                | string[]
                | string & {}
                | (
                    | "description"
                    | string & {}
                    | "issueTypes"
                    | "lead"
                    | "issueTypeHierarchy"
                    | "projectKeys"
                )[];
            projectIdOrKey: string;
            properties?: string[];
        }
        • Optionalexpand?:
              | string
              | string[]
              | string & {}
              | (
                  | "description"
                  | string & {}
                  | "issueTypes"
                  | "lead"
                  | "issueTypeHierarchy"
                  | "projectKeys"
              )[]

          Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include:

          • description The project description.
          • issueTypes The issue types associated with the project.
          • lead The project lead.
          • projectKeys All project keys associated with the project.
          • issueTypeHierarchy The project issue type hierarchy.
        • projectIdOrKey: string

          The project ID or project key (case sensitive).

        • Optionalproperties?: string[]

          A list of project properties to return for the project. This parameter accepts a comma-separated list.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              archived?: boolean;
              archivedBy?: {
                  accountId?: string;
                  accountType?: "unknown"
                  | string & {}
                  | "atlassian"
                  | "app"
                  | "customer";
                  active?: boolean;
                  applicationRoles?: {
                      callback?: { [key: string]: unknown };
                      items?: {
                          defaultGroups?: (...)[];
                          defaultGroupsDetails?: (...)[];
                          defined?: boolean;
                          groupDetails?: (...)[];
                          groups?: (...)[];
                          hasUnlimitedSeats?: boolean;
                          key?: string;
                          name?: string;
                          numberOfSeats?: number;
                          platform?: boolean;
                          remainingSeats?: number;
                          selectedByDefault?: boolean;
                          userCount?: number;
                          userCountDescription?: string;
                          [key: string]: unknown;
                      }[];
                      "max-results"?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  appType?: string;
                  avatarUrls?: {
                      "16x16"?: string;
                      "24x24"?: string;
                      "32x32"?: string;
                      "48x48"?: string;
                      [key: string]: unknown;
                  };
                  displayName?: string;
                  emailAddress?: string;
                  expand?: string;
                  groups?: {
                      callback?: { [key: string]: unknown };
                      items?: {
                          groupId?: string | null;
                          name?: string;
                          self?: string;
                          [key: string]: unknown;
                      }[];
                      "max-results"?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  guest?: boolean;
                  locale?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              archivedDate?: Date;
              assigneeType?: string & {}
              | "PROJECT_LEAD"
              | "UNASSIGNED";
              avatarUrls?: {
                  "16x16"?: string;
                  "24x24"?: string;
                  "32x32"?: string;
                  "48x48"?: string;
                  [key: string]: unknown;
              };
              components?: {
                  ari?: string;
                  assignee?: {
                      accountId?: string;
                      accountType?: "unknown"
                      | string & {}
                      | "atlassian"
                      | "app"
                      | "customer";
                      active?: boolean;
                      applicationRoles?: {
                          callback?: { [key: ...]: ... };
                          items?: (...)[];
                          "max-results"?: number;
                          pagingCallback?: { [key: ...]: ... };
                          size?: number;
                          [key: string]: unknown;
                      };
                      appType?: string;
                      avatarUrls?: {
                          "16x16"?: string;
                          "24x24"?: string;
                          "32x32"?: string;
                          "48x48"?: string;
                          [key: string]: unknown;
                      };
                      displayName?: string;
                      emailAddress?: string;
                      expand?: string;
                      groups?: {
                          callback?: { [key: ...]: ... };
                          items?: (...)[];
                          "max-results"?: number;
                          pagingCallback?: { [key: ...]: ... };
                          size?: number;
                          [key: string]: unknown;
                      };
                      guest?: boolean;
                      locale?: string;
                      self?: string;
                      timeZone?: string;
                      [key: string]: unknown;
                  };
                  assigneeType?: | string & {}
                  | "PROJECT_DEFAULT"
                  | "COMPONENT_LEAD"
                  | "PROJECT_LEAD"
                  | "UNASSIGNED";
                  description?: string;
                  id?: string;
                  isAssigneeTypeValid?: boolean;
                  lead?: {
                      accountId?: string;
                      accountType?: "unknown"
                      | string & {}
                      | "atlassian"
                      | "app"
                      | "customer";
                      active?: boolean;
                      applicationRoles?: {
                          callback?: { [key: ...]: ... };
                          items?: (...)[];
                          "max-results"?: number;
                          pagingCallback?: { [key: ...]: ... };
                          size?: number;
                          [key: string]: unknown;
                      };
                      appType?: string;
                      avatarUrls?: {
                          "16x16"?: string;
                          "24x24"?: string;
                          "32x32"?: string;
                          "48x48"?: string;
                          [key: string]: unknown;
                      };
                      displayName?: string;
                      emailAddress?: string;
                      expand?: string;
                      groups?: {
                          callback?: { [key: ...]: ... };
                          items?: (...)[];
                          "max-results"?: number;
                          pagingCallback?: { [key: ...]: ... };
                          size?: number;
                          [key: string]: unknown;
                      };
                      guest?: boolean;
                      locale?: string;
                      self?: string;
                      timeZone?: string;
                      [key: string]: unknown;
                  };
                  leadAccountId?: string;
                  metadata?: Record<string, any>;
                  name?: string;
                  project?: string;
                  projectId?: number;
                  realAssignee?: {
                      accountId?: string;
                      accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
                      active?: boolean;
                      applicationRoles?: {
                          callback?: { [key: ...]: ... };
                          items?: (...)[];
                          "max-results"?: number;
                          pagingCallback?: { [key: ...]: ... };
                          size?: number;
                          [key: string]: unknown;
                      };
                      appType?: string;
                      avatarUrls?: {
                          "16x16"?: string;
                          "24x24"?: string;
                          "32x32"?: string;
                          "48x48"?: string;
                          [key: string]: unknown;
                      };
                      displayName?: string;
                      emailAddress?: string;
                      expand?: string;
                      groups?: {
                          callback?: { [key: ...]: ... };
                          items?: (...)[];
                          "max-results"?: number;
                          pagingCallback?: { [key: ...]: ... };
                          size?: number;
                          [key: string]: unknown;
                      };
                      guest?: boolean;
                      locale?: string;
                      self?: string;
                      timeZone?: string;
                      [key: string]: unknown;
                  };
                  realAssigneeType?: | string & {}
                  | "PROJECT_DEFAULT"
                  | "COMPONENT_LEAD"
                  | "PROJECT_LEAD"
                  | "UNASSIGNED";
                  self?: string;
                  [key: string]: unknown;
              }[];
              deleted?: boolean;
              deletedBy?: {
                  accountId?: string;
                  accountType?: "unknown"
                  | string & {}
                  | "atlassian"
                  | "app"
                  | "customer";
                  active?: boolean;
                  applicationRoles?: {
                      callback?: { [key: string]: unknown };
                      items?: {
                          defaultGroups?: (...)[];
                          defaultGroupsDetails?: (...)[];
                          defined?: boolean;
                          groupDetails?: (...)[];
                          groups?: (...)[];
                          hasUnlimitedSeats?: boolean;
                          key?: string;
                          name?: string;
                          numberOfSeats?: number;
                          platform?: boolean;
                          remainingSeats?: number;
                          selectedByDefault?: boolean;
                          userCount?: number;
                          userCountDescription?: string;
                          [key: string]: unknown;
                      }[];
                      "max-results"?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  appType?: string;
                  avatarUrls?: {
                      "16x16"?: string;
                      "24x24"?: string;
                      "32x32"?: string;
                      "48x48"?: string;
                      [key: string]: unknown;
                  };
                  displayName?: string;
                  emailAddress?: string;
                  expand?: string;
                  groups?: {
                      callback?: { [key: string]: unknown };
                      items?: {
                          groupId?: string | null;
                          name?: string;
                          self?: string;
                          [key: string]: unknown;
                      }[];
                      "max-results"?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  guest?: boolean;
                  locale?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              deletedDate?: Date;
              description?: string;
              email?: string;
              entityId?: string;
              expand?: string;
              favourite?: boolean;
              id?: string;
              insight?: {
                  lastIssueUpdateTime?: Date;
                  totalIssueCount?: number;
                  [key: string]: unknown;
              };
              isPrivate?: boolean;
              issueTypeHierarchy?: {
                  levels?: {
                      hierarchyLevelNumber?: number;
                      issueTypeIds?: number[];
                      level?: number;
                      name?: string;
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              };
              issueTypes?: {
                  avatarId?: number;
                  description?: string;
                  entityId?: string;
                  hierarchyLevel?: number;
                  iconUrl?: string;
                  id?: string;
                  name?: string;
                  scope?: {
                      project?: {
                          avatarUrls?: {
                              "16x16"?: ...;
                              "24x24"?: ...;
                              "32x32"?: ...;
                              "48x48"?: ...;
                              [key: ...]: ...;
                          };
                          id?: string;
                          key?: string;
                          name?: string;
                          projectCategory?: {
                              description?: ...;
                              id?: ...;
                              name?: ...;
                              self?: ...;
                              [key: ...]: ...;
                          };
                          projectTypeKey?: | (...) & (...)
                          | "software"
                          | "service_desk"
                          | "business"
                          | "product_discovery"
                          | "customer_service";
                          self?: string;
                          simplified?: boolean;
                          [key: string]: unknown;
                      };
                      type?: string & {}
                      | "PROJECT"
                      | "TEMPLATE";
                      [key: string]: unknown;
                  };
                  self?: string;
                  subtask?: boolean;
                  untranslatedName?: string;
                  [key: string]: unknown;
              }[];
              key?: string;
              landingPageInfo?: {
                  attributes?: Record<string, any>;
                  boardId?: number;
                  boardName?: string;
                  projectKey?: string;
                  projectType?: string;
                  queueCategory?: string;
                  queueId?: number;
                  queueName?: string;
                  simpleBoard?: boolean;
                  simplified?: boolean;
                  url?: string;
                  [key: string]: unknown;
              };
              lead?: {
                  accountId?: string;
                  accountType?: "unknown"
                  | string & {}
                  | "atlassian"
                  | "app"
                  | "customer";
                  active?: boolean;
                  applicationRoles?: {
                      callback?: { [key: string]: unknown };
                      items?: {
                          defaultGroups?: (...)[];
                          defaultGroupsDetails?: (...)[];
                          defined?: boolean;
                          groupDetails?: (...)[];
                          groups?: (...)[];
                          hasUnlimitedSeats?: boolean;
                          key?: string;
                          name?: string;
                          numberOfSeats?: number;
                          platform?: boolean;
                          remainingSeats?: number;
                          selectedByDefault?: boolean;
                          userCount?: number;
                          userCountDescription?: string;
                          [key: string]: unknown;
                      }[];
                      "max-results"?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  appType?: string;
                  avatarUrls?: {
                      "16x16"?: string;
                      "24x24"?: string;
                      "32x32"?: string;
                      "48x48"?: string;
                      [key: string]: unknown;
                  };
                  displayName?: string;
                  emailAddress?: string;
                  expand?: string;
                  groups?: {
                      callback?: { [key: string]: unknown };
                      items?: {
                          groupId?: string | null;
                          name?: string;
                          self?: string;
                          [key: string]: unknown;
                      }[];
                      "max-results"?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  guest?: boolean;
                  locale?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              name?: string;
              permissions?: { canEdit?: boolean; [key: string]: unknown };
              projectCategory?: {
                  description?: string;
                  id?: string;
                  name?: string;
                  self?: string;
                  [key: string]: unknown;
              };
              projectTypeKey?: | string & {}
              | "software"
              | "service_desk"
              | "business"
              | "product_discovery"
              | "customer_service";
              properties?: Record<string, any>;
              retentionTillDate?: Date;
              roles?: Record<string, any>;
              self?: string;
              simplified?: boolean;
              style?: "classic" | string & {} | "next-gen";
              url?: string;
              uuid?: string;
              versions?: {
                  approvers?: {
                      accountId?: string;
                      declineReason?: string;
                      description?: string;
                      status?: string;
                      [key: string]: unknown;
                  }[];
                  archived?: boolean;
                  description?: string;
                  driver?: string;
                  expand?: string;
                  id?: string;
                  issuesStatusForFixVersion?: {
                      done?: number;
                      inProgress?: number;
                      toDo?: number;
                      unmapped?: number;
                      [key: string]: unknown;
                  };
                  moveUnfixedIssuesTo?: string;
                  name?: string;
                  operations?: {
                      href?: string;
                      iconClass?: string;
                      id?: string;
                      label?: string;
                      styleClass?: string;
                      title?: string;
                      weight?: number;
                      [key: string]: unknown;
                  }[];
                  overdue?: boolean;
                  projectId?: number;
                  released?: boolean;
                  releaseDate?: string;
                  self?: string;
                  startDate?: string;
                  userReleaseDate?: string;
                  userStartDate?: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility