Skip to content

Function: getEnterpriseMember()

ts
function getEnterpriseMember(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/enterprises.ts:165

Get a specific member of an enterprise by ID.

Parameters

ParameterTypeDescription
clientClient-
parameters{ boardFields?: string; fields?: string; id: unknown; idMember: unknown; organizationFields?: string; }-
parameters.boardFields?stringAny valid value that the nested board resource accepts.
parameters.fields?stringA comma separated list of any valid values that the nested member field resource accepts.
parameters.idunknownID of the enterprise to retrieve.
parameters.idMemberunknownAn ID of a member resource.
parameters.organizationFields?stringAny valid value that the nested organization field resource accepts.

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; }>