Skip to main content

SyncWorkspace

type SyncWorkspace = {
adminSortingApplied: boolean;
createdAt: Date | undefined;
creatorId: string;
currentActiveProjects: number | null;
currentMemberCount: number | null;
currentTemplateCount: number | null;
defaultCollaborators?: {
predefinedGroupIds: string[];
userIds: string[];
};
description: string;
domainDiscovery?: boolean | null;
domainName?: string | null;
id: string;
inviteCode?: string | null;
isCollapsed: boolean;
isDeleted: boolean;
isGuestAllowed?: boolean | null;
isLinkSharingEnabled?: boolean | null;
limits?: {
[key: string]: any;
current: Record<string, any> | null;
next: Record<string, any> | null;
};
logoBig?: string | null;
logoMedium?: string | null;
logoS640?: string | null;
logoSmall?: string | null;
memberCountByType?: {
adminCount: number;
guestCount: number;
memberCount: number;
};
name: string;
pendingInvitations?: string[] | null;
plan: "STARTER" | "BUSINESS";
projectSortPreference?: string | null;
properties?: Record<string, unknown>;
restrictEmailDomains?: boolean | null;
role?: "ADMIN" | "MEMBER" | "GUEST";
};

Sync API workspace resource.

This is a superset of the REST WorkspaceSchema — the Sync API returns additional fields like description, isDeleted, isCollapsed, member counts, domain settings, and sorting preferences.

Type Declaration

NameTypeDefault value
adminSortingAppliedboolean-
createdAtDate | undefined-
creatorIdstringStringOrNumberSchema
currentActiveProjectsnumber | null-
currentMemberCountnumber | null-
currentTemplateCountnumber | null-
defaultCollaborators?{ predefinedGroupIds: string[]; userIds: string[]; }-
defaultCollaborators.predefinedGroupIdsstring[]-
defaultCollaborators.userIdsstring[]-
descriptionstring-
domainDiscovery?boolean | null-
domainName?string | null-
idstringStringOrNumberSchema
inviteCode?string | null-
isCollapsedboolean-
isDeletedboolean-
isGuestAllowed?boolean | null-
isLinkSharingEnabled?boolean | null-
limits?{ [key: string]: any; current: Record<string, any> | null; next: Record<string, any> | null; }-
limits.currentRecord<string, any> | null-
limits.nextRecord<string, any> | null-
logoBig?string | null-
logoMedium?string | null-
logoS640?string | null-
logoSmall?string | null-
memberCountByType?{ adminCount: number; guestCount: number; memberCount: number; }-
memberCountByType.adminCountnumber-
memberCountByType.guestCountnumber-
memberCountByType.memberCountnumber-
namestring-
pendingInvitations?string[] | null-
plan"STARTER" | "BUSINESS"WorkspacePlanSchema
projectSortPreference?string | null-
properties?Record<string, unknown>-
restrictEmailDomains?boolean | null-
role?"ADMIN" | "MEMBER" | "GUEST"-