Skip to content

Type Alias: GetMember ​

ts
type GetMember = object;

Defined in: parameters/getMember.ts:260

Type Declaration ​

actions? ​

ts
optional actions?: string;

See the Actions Nested Resource

boardBackgrounds? ​

ts
optional boardBackgrounds?: "default" | "all" | "none" | "custom" | string & object | "premium";

One of: all, custom, default, none, premium

boards? ​

ts
optional boards?: string;

See the Boards Nested Resource

boardsInvited? ​

ts
optional boardsInvited?: 
  | "closed"
  | "open"
  | "public"
  | "organization"
  | string & object
  | "pinned"
  | "starred"
  | "members"
  | "unpinned";

all or a comma-separated list of: closed, members, open, organization, pinned, public, starred, unpinned

boardsInvitedFields? ​

ts
optional boardsInvitedFields?: 
  | "name"
  | "id"
  | "url"
  | "closed"
  | "desc"
  | string & object
  | "prefs"
  | "limits"
  | "idMemberCreator"
  | "memberships"
  | "descData"
  | "idOrganization"
  | "pinned"
  | "shortUrl"
  | "labelNames"
  | "starred"
  | "enterpriseOwned"
  | (
  | "name"
  | "id"
  | "url"
  | "closed"
  | "desc"
  | string & object
  | "prefs"
  | "limits"
  | "idMemberCreator"
  | "memberships"
  | "descData"
  | "idOrganization"
  | "pinned"
  | "shortUrl"
  | "labelNames"
  | "starred"
  | "enterpriseOwned")[];

all or a comma-separated list of board fields

boardStars? ​

ts
optional boardStars?: boolean;

Whether to return the boardStars or not

cards? ​

ts
optional cards?: string;

See the Cards Nested Resource for additional options

customBoardBackgrounds? ​

ts
optional customBoardBackgrounds?: "all" | "none" | string & object;

all or none

customEmoji? ​

ts
optional customEmoji?: "all" | "none" | string & object;

all or none

customStickers? ​

ts
optional customStickers?: "all" | "none" | string & object;

all or none

fields? ​

ts
optional fields?: 
  | "id"
  | "url"
  | "username"
  | "status"
  | string & object
  | "fullName"
  | "activityBlocked"
  | "avatarHash"
  | "avatarUrl"
  | "bio"
  | "bioData"
  | "confirmed"
  | "idEnterprise"
  | "idMemberReferrer"
  | "idPremOrgsAdmin"
  | "initials"
  | "memberType"
  | "nonPublic"
  | "nonPublicAvailable"
  | "products"
  | "idBoards"
  | "idOrganizations"
  | (
  | "id"
  | "url"
  | "username"
  | "status"
  | string & object
  | "fullName"
  | "activityBlocked"
  | "avatarHash"
  | "avatarUrl"
  | "bio"
  | "bioData"
  | "confirmed"
  | "idEnterprise"
  | "idMemberReferrer"
  | "idPremOrgsAdmin"
  | "initials"
  | "memberType"
  | "nonPublic"
  | "nonPublicAvailable"
  | "products"
  | "idBoards"
  | "idOrganizations")[];

all or a comma-separated list of member fields

id ​

ts
id: string;

The ID or username of the member

notifications? ​

ts
optional notifications?: string;

See the Notifications Nested Resource

organizationFields? ​

ts
optional organizationFields?: 
  | "name"
  | "id"
  | "url"
  | "desc"
  | string & object
  | "prefs"
  | "products"
  | "idBoards"
  | "premiumFeatures"
  | "displayName"
  | "invitations"
  | "memberships"
  | "descData"
  | "logoHash"
  | "powerUps"
  | "website"
  | "billableMemberCount"
  | "invited"
  | (
  | "name"
  | "id"
  | "url"
  | "desc"
  | string & object
  | "prefs"
  | "products"
  | "idBoards"
  | "premiumFeatures"
  | "displayName"
  | "invitations"
  | "memberships"
  | "descData"
  | "logoHash"
  | "powerUps"
  | "website"
  | "billableMemberCount"
  | "invited")[];

all or a comma-separated list of organization fields

organizationPaidAccount? ​

ts
optional organizationPaidAccount?: boolean;

Whether or not to include paid account information in the returned workspace object

organizations? ​

ts
optional organizations?: "all" | "none" | "public" | string & object | "members";

One of: all, members, none, public

organizationsInvited? ​

ts
optional organizationsInvited?: "all" | "none" | "public" | string & object | "members";

One of: all, members, none, public

organizationsInvitedFields? ​

ts
optional organizationsInvitedFields?: 
  | "name"
  | "id"
  | "url"
  | "desc"
  | string & object
  | "prefs"
  | "products"
  | "idBoards"
  | "premiumFeatures"
  | "displayName"
  | "invitations"
  | "memberships"
  | "descData"
  | "logoHash"
  | "powerUps"
  | "website"
  | "billableMemberCount"
  | "invited"
  | (
  | "name"
  | "id"
  | "url"
  | "desc"
  | string & object
  | "prefs"
  | "products"
  | "idBoards"
  | "premiumFeatures"
  | "displayName"
  | "invitations"
  | "memberships"
  | "descData"
  | "logoHash"
  | "powerUps"
  | "website"
  | "billableMemberCount"
  | "invited")[];

all or a comma-separated list of organization fields

paidAccount? ​

ts
optional paidAccount?: boolean;

Whether or not to include paid account information in the returned member object

savedSearches? ​

ts
optional savedSearches?: boolean;

tokens? ​

ts
optional tokens?: "all" | "none" | string & object;

all or none