Function: getMember()
function getMember(client, parameters): Promise<{
aaBlockSyncUntil?: string | null;
aaEmail?: string | null;
aaEnrolledDate?: Date | null;
aaId?: string | null;
active?: boolean;
activityBlocked?: boolean;
avatarHash?: string;
avatarSource?: "none" | "gravatar" | "upload";
avatarUrl?: string;
bio?: string;
bioData?: | {
emoji?: Record<string, any>;
}
| null;
boards?: unknown[];
confirmed?: boolean;
credentialsRemovedCount?: number;
dateLastActive?: Date;
dateLastImpression?: Date;
domainClaimed?: string | null;
email?: string;
fullName?: string;
gravatarHash?: string;
id: string;
idBoards?: string[];
idBoardsPinned?: string[] | null;
idEnterprise?: string | null;
idEnterprisesAdmin?: string[];
idEnterprisesDeactivated?: string[];
idMemberReferrer?: string | null;
idOrganizations?: string[];
idPremOrgsAdmin?: string[];
initials?: string;
isAaMastered?: boolean;
ixUpdate?: string;
lastActive?: unknown;
limits?: {
attachments?: {
perBoard?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
perCard?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
};
boards?: {
totalAccessRequestsPerBoard?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
totalMembersPerBoard?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
totalPerMember?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
};
cards?: {
openPerBoard?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
openPerList?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
totalPerBoard?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
totalPerList?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
};
checkItems?: {
perChecklist?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
};
checklists?: {
perBoard?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
perCard?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
};
customFieldOptions?: {
perField?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
};
customFields?: {
perBoard?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
};
labels?: {
perBoard?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
};
lists?: {
openPerBoard?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
totalPerBoard?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
};
orgs?: {
freeBoardsPerOrg?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
totalMembersPerOrg?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
totalPerMember?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
usersPerFreeOrg?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
};
reactions?: {
perAction?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
uniquePerAction?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
};
stickers?: {
perCard?: {
count?: number;
disableAt: number;
status: string;
warnAt: number;
};
};
};
loginTypes?: string[];
marketingOptIn?: {
date?: Date;
optedIn?: boolean;
};
memberType?: "normal" | "ghost";
messagesDismissed?: object[];
nodeId?: string;
nonPublic?: {
avatarHash?: string;
avatarUrl?: string;
fullName?: string;
initials?: string;
};
nonPublicAvailable?: boolean;
notifications?: unknown[];
oneTimeMessagesDismissed?: string[];
organizations?: unknown[];
prefs?: {
colorBlind?: boolean;
keyboardShortcutsEnabled?: boolean;
locale?: string;
minutesBeforeDeadlineToNotify?: number;
minutesBetweenSummaries?: number;
privacy?: {
avatar?: "private" | "public" | "collaborator";
fullName?: "private" | "public" | "collaborator";
};
sendSummaries?: boolean;
timezone?: string;
timezoneInfo?: {
dateNext?: Date;
offsetCurrent?: number;
offsetNext?: number;
timezoneCurrent?: string;
timezoneNext?: string;
};
twoFactor?: {
enabled?: boolean;
needsNewBackups?: boolean;
};
};
premiumFeatures?: string[];
products?: number[];
sessionType?: string | null;
similarity?: number;
status?: "disconnected";
trophies?: string[];
uploadedAvatarHash?: string | null;
uploadedAvatarUrl?: string | null;
url?: string;
username?: string;
}>;Defined in: api/members.ts:67
Get a member
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { actions?: string; boardBackgrounds?: "default" | "all" | "none" | "custom" | "premium"; boards?: string; boardsInvited?: | "closed" | "open" | "public" | "organization" | "pinned" | "starred" | "members" | "unpinned"; boardsInvitedFields?: unknown; boardStars?: boolean; cards?: string; customBoardBackgrounds?: "all" | "none"; customEmoji?: "all" | "none"; customStickers?: "all" | "none"; fields?: unknown; id: unknown; notifications?: string; organizationFields?: unknown; organizationPaidAccount?: boolean; organizations?: "all" | "none" | "public" | "members"; organizationsInvited?: "all" | "none" | "public" | "members"; organizationsInvitedFields?: unknown; paidAccount?: boolean; savedSearches?: boolean; tokens?: "all" | "none"; } | - |
parameters.actions? | string | See the Actions Nested Resource |
parameters.boardBackgrounds? | "default" | "all" | "none" | "custom" | "premium" | One of: all, custom, default, none, premium |
parameters.boards? | string | See the Boards Nested Resource |
parameters.boardsInvited? | | "closed" | "open" | "public" | "organization" | "pinned" | "starred" | "members" | "unpinned" | all or a comma-separated list of: closed, members, open, organization, pinned, public, starred, unpinned |
parameters.boardsInvitedFields? | unknown | all or a comma-separated list of board fields |
parameters.boardStars? | boolean | Whether to return the boardStars or not |
parameters.cards? | string | See the Cards Nested Resource for additional options |
parameters.customBoardBackgrounds? | "all" | "none" | all or none |
parameters.customEmoji? | "all" | "none" | all or none |
parameters.customStickers? | "all" | "none" | all or none |
parameters.fields? | unknown | all or a comma-separated list of member fields |
parameters.id | unknown | The ID or username of the member |
parameters.notifications? | string | See the Notifications Nested Resource |
parameters.organizationFields? | unknown | all or a comma-separated list of organization fields |
parameters.organizationPaidAccount? | boolean | Whether or not to include paid account information in the returned workspace object |
parameters.organizations? | "all" | "none" | "public" | "members" | One of: all, members, none, public |
parameters.organizationsInvited? | "all" | "none" | "public" | "members" | One of: all, members, none, public |
parameters.organizationsInvitedFields? | unknown | all or a comma-separated list of organization fields |
parameters.paidAccount? | boolean | Whether or not to include paid account information in the returned member object |
parameters.savedSearches? | boolean | - |
parameters.tokens? | "all" | "none" | all or none |
Returns
Promise<{ aaBlockSyncUntil?: string | null; aaEmail?: string | null; aaEnrolledDate?: Date | null; aaId?: string | null; active?: boolean; activityBlocked?: boolean; avatarHash?: string; avatarSource?: "none" | "gravatar" | "upload"; avatarUrl?: string; bio?: string; bioData?: | { emoji?: Record<string, any>; } | null; boards?: unknown[]; confirmed?: boolean; credentialsRemovedCount?: number; dateLastActive?: Date; dateLastImpression?: Date; domainClaimed?: string | null; email?: string; fullName?: string; gravatarHash?: string; id: string; idBoards?: string[]; idBoardsPinned?: string[] | null; idEnterprise?: string | null; idEnterprisesAdmin?: string[]; idEnterprisesDeactivated?: string[]; idMemberReferrer?: string | null; idOrganizations?: string[]; idPremOrgsAdmin?: string[]; initials?: string; isAaMastered?: boolean; ixUpdate?: string; lastActive?: unknown; limits?: { attachments?: { perBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; perCard?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; boards?: { totalAccessRequestsPerBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalMembersPerBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalPerMember?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; cards?: { openPerBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; openPerList?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalPerBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalPerList?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; checkItems?: { perChecklist?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; checklists?: { perBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; perCard?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; customFieldOptions?: { perField?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; customFields?: { perBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; labels?: { perBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; lists?: { openPerBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalPerBoard?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; orgs?: { freeBoardsPerOrg?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalMembersPerOrg?: { count?: number; disableAt: number; status: string; warnAt: number; }; totalPerMember?: { count?: number; disableAt: number; status: string; warnAt: number; }; usersPerFreeOrg?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; reactions?: { perAction?: { count?: number; disableAt: number; status: string; warnAt: number; }; uniquePerAction?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; stickers?: { perCard?: { count?: number; disableAt: number; status: string; warnAt: number; }; }; }; loginTypes?: string[]; marketingOptIn?: { date?: Date; optedIn?: boolean; }; memberType?: "normal" | "ghost"; messagesDismissed?: object[]; nodeId?: string; nonPublic?: { avatarHash?: string; avatarUrl?: string; fullName?: string; initials?: string; }; nonPublicAvailable?: boolean; notifications?: unknown[]; oneTimeMessagesDismissed?: string[]; organizations?: unknown[]; prefs?: { colorBlind?: boolean; keyboardShortcutsEnabled?: boolean; locale?: string; minutesBeforeDeadlineToNotify?: number; minutesBetweenSummaries?: number; privacy?: { avatar?: "private" | "public" | "collaborator"; fullName?: "private" | "public" | "collaborator"; }; sendSummaries?: boolean; timezone?: string; timezoneInfo?: { dateNext?: Date; offsetCurrent?: number; offsetNext?: number; timezoneCurrent?: string; timezoneNext?: string; }; twoFactor?: { enabled?: boolean; needsNewBackups?: boolean; }; }; premiumFeatures?: string[]; products?: number[]; sessionType?: string | null; similarity?: number; status?: "disconnected"; trophies?: string[]; uploadedAvatarHash?: string | null; uploadedAvatarUrl?: string | null; url?: string; username?: string; }>