Type Alias: GetBoard

type GetBoard = object;

Defined in: parameters/getBoard.ts:120

Type Declaration

actions?

optional actions?: string;

This is a nested resource. Read more about actions as nested resources here.

boardStars?

optional boardStars?: "none" | string & object | "mine";

Valid values are one of: mine or none.

cardPluginData?

optional cardPluginData?: boolean;

Use with the cards param to include card pluginData with the response

cards?

optional cards?: string;

This is a nested resource. Read more about cards as nested resources here.

checklists?

optional checklists?: string;

This is a nested resource. Read more about checklists as nested resources here.

customFields?

optional customFields?: boolean;

This is a nested resource. Read more about custom fields as nested resources here.

fields?

optional fields?: 
  | "name"
  | "url"
  | "closed"
  | "desc"
  | string & object
  | "shortLink"
  | "prefs"
  | "idMemberCreator"
  | "invitations"
  | "dateLastActivity"
  | "memberships"
  | "descData"
  | "powerUps"
  | "invited"
  | "idOrganization"
  | "pinned"
  | "shortUrl"
  | "labelNames"
  | "starred"
  | "subscribed"
  | "dateLastView"
  | (
  | "name"
  | "url"
  | "closed"
  | "desc"
  | string & object
  | "shortLink"
  | "prefs"
  | "idMemberCreator"
  | "invitations"
  | "dateLastActivity"
  | "memberships"
  | "descData"
  | "powerUps"
  | "invited"
  | "idOrganization"
  | "pinned"
  | "shortUrl"
  | "labelNames"
  | "starred"
  | "subscribed"
  | "dateLastView")[];

The fields of the board to be included in the response. Valid values: all or a comma-separated list of: closed, dateLastActivity, dateLastView, desc, descData, idMemberCreator, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed, url

id

id: string;

labels?

optional labels?: string;

This is a nested resource. Read more about labels as nested resources here.

lists?

optional lists?: string;

This is a nested resource. Read more about lists as nested resources here.

members?

optional members?: string;

This is a nested resource. Read more about members as nested resources here.

memberships?

optional memberships?: string;

This is a nested resource. Read more about memberships as nested resources here.

myPrefs?

optional myPrefs?: boolean;

organization?

optional organization?: boolean;

This is a nested resource. Read more about organizations as nested resources here.

organizationPluginData?

optional organizationPluginData?: boolean;

Use with the organization param to include organization pluginData with the response

pluginData?

optional pluginData?: boolean;

Determines whether the pluginData for this board should be returned. Valid values: true or false.

tags?

optional tags?: boolean;

Also known as collections, tags, refer to the collection(s) that a Board belongs to.