Type Alias: GetBoardMemberships

type GetBoardMemberships = object;

Defined in: parameters/getBoardMemberships.ts:76

Type Declaration

activity?

optional activity?: boolean;

Works for premium organizations only.

filter?

optional filter?: "all" | "none" | "normal" | string & object | "admins";

One of admins, all, none, normal

id

id: string;

The ID of the board

member?

optional member?: boolean;

Determines whether to include a nested member object.

memberFields?

optional memberFields?: 
  | "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")[];

Fields to show if member=true. Valid values: nested member resource fields.

orgMemberType?

optional orgMemberType?: boolean;

Shows the type of member to the org the user is. For instance, an org admin will have a orgMemberType of admin.