Skip to content

Type Alias: GetBoardLists ​

ts
type GetBoardLists = object;

Defined in: parameters/getBoardLists.ts:133

Type Declaration ​

cardFields? ​

ts
optional cardFields?: 
  | "name"
  | "id"
  | "address"
  | "url"
  | "closed"
  | "desc"
  | "labels"
  | string & object
  | "idShort"
  | "shortLink"
  | "idList"
  | "idLabels"
  | "pos"
  | "due"
  | "dueComplete"
  | "limits"
  | "creationMethod"
  | "isTemplate"
  | "dateLastActivity"
  | "descData"
  | "shortUrl"
  | "subscribed"
  | "dueReminder"
  | "idBoard"
  | "badges"
  | "checkItemStates"
  | "coordinates"
  | "idChecklists"
  | "idMembers"
  | "idMembersVoted"
  | "idAttachmentCover"
  | "locationName"
  | "manualCoverAttachment"
  | "cover"
  | (
  | "name"
  | "id"
  | "address"
  | "url"
  | "closed"
  | "desc"
  | "labels"
  | string & object
  | "idShort"
  | "shortLink"
  | "idList"
  | "idLabels"
  | "pos"
  | "due"
  | "dueComplete"
  | "limits"
  | "creationMethod"
  | "isTemplate"
  | "dateLastActivity"
  | "descData"
  | "shortUrl"
  | "subscribed"
  | "dueReminder"
  | "idBoard"
  | "badges"
  | "checkItemStates"
  | "coordinates"
  | "idChecklists"
  | "idMembers"
  | "idMembersVoted"
  | "idAttachmentCover"
  | "locationName"
  | "manualCoverAttachment"
  | "cover")[];

all or a comma-separated list of card fields

cards? ​

ts
optional cards?: "all" | "none" | "closed" | "open" | string & object;

Filter to apply to Cards.

fields? ​

ts
optional fields?: 
  | "filter"
  | "name"
  | "type"
  | "id"
  | "closed"
  | "color"
  | string & object
  | "pos"
  | "creationMethod"
  | "idOrganization"
  | "subscribed"
  | "idBoard"
  | "softLimit"
  | "datasource"
  | (
  | "filter"
  | "name"
  | "type"
  | "id"
  | "closed"
  | "color"
  | string & object
  | "pos"
  | "creationMethod"
  | "idOrganization"
  | "subscribed"
  | "idBoard"
  | "softLimit"
  | "datasource")[];

all or a comma-separated list of list fields

filter? ​

ts
optional filter?: "all" | "none" | "closed" | "open" | string & object;

Filter to apply to Lists

id ​

ts
id: string;

The ID of the board