Skip to main content

WorkspaceProjectSummary

type WorkspaceProjectSummary = {
access?: {
visibility: "restricted" | "team" | "public";
};
canAssignTasks: boolean;
color: string;
defaultOrder: number;
defaultOrderKey?: string | null;
description: string;
folderId: string | null;
icon: string | null;
id: string;
isFrozen: boolean;
isInviteOnly: boolean | null;
isPendingDefaultCollaboratorInvites: boolean;
name: string;
publicAccess: boolean;
publicKey: string;
role: string | null;
status: string;
url: string;
viewStyle: string;
workspaceId: string;
};

A workspace project as listed by getWorkspaceActiveProjects or getWorkspaceArchivedProjects. role is null when the user can see the project but hasn't joined it; join it with joinProject.

Type Declaration​

NameTypeDefault value
access?{ visibility: "restricted" | "team" | "public"; }-
access.visibility"restricted" | "team" | "public"ProjectVisibilitySchema
canAssignTasksboolean-
colorstring-
defaultOrdernumber-
defaultOrderKey?string | null-
descriptionstring-
folderIdstring | null-
iconstring | null-
idstring-
isFrozenboolean-
isInviteOnlyboolean | null-
isPendingDefaultCollaboratorInvitesboolean-
namestring-
publicAccessboolean-
publicKeystring-
rolestring | null-
statusstring-
urlstring-
viewStylestring-
workspaceIdstring-