Skip to main content

SyncWorkspace

type SyncWorkspace = {
[key: string]: unknown;
adminSortingApplied: boolean;
createdAt: string;
creatorId: string;
currentActiveProjects: number | null;
currentMemberCount: number | null;
currentTemplateCount: number | null;
defaultCollaborators?: {
predefinedGroupIds: string[];
userIds: number[];
};
description: string;
domainDiscovery?: boolean;
domainName?: string;
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;
logoMedium?: string;
logoS640?: string;
logoSmall?: string;
memberCountByType?: {
adminCount: number;
guestCount: number;
memberCount: number;
};
name: string;
pendingInvitations?: string[] | null;
plan: "STARTER" | "BUSINESS";
projectSortPreference?: string;
properties?: Record<string, unknown>;
restrictEmailDomains?: boolean;
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

Index Signature

[key: string]: unknown
NameTypeDefault value
adminSortingAppliedboolean-
createdAtstring-
creatorIdstring-
currentActiveProjectsnumber | null-
currentMemberCountnumber | null-
currentTemplateCountnumber | null-
defaultCollaborators?{ predefinedGroupIds: string[]; userIds: number[]; }-
defaultCollaborators.predefinedGroupIdsstring[]-
defaultCollaborators.userIdsnumber[]-
descriptionstring-
domainDiscovery?boolean-
domainName?string-
idstring-
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; }WorkspaceLimitsSchema
limits.currentRecord<string, any> | null-
limits.nextRecord<string, any> | null-
logoBig?string-
logoMedium?string-
logoS640?string-
logoSmall?string-
memberCountByType?{ adminCount: number; guestCount: number; memberCount: number; }-
memberCountByType.adminCountnumber-
memberCountByType.guestCountnumber-
memberCountByType.memberCountnumber-
namestring-
pendingInvitations?string[] | null-
plan"STARTER" | "BUSINESS"WorkspacePlanSchema
projectSortPreference?string-
properties?Record<string, unknown>-
restrictEmailDomains?boolean-
role"ADMIN" | "MEMBER" | "GUEST"WorkspaceRoleSchema