Skip to content

Type Alias: GetChecklist ​

ts
type GetChecklist = object;

Defined in: parameters/getChecklist.ts:37

Type Declaration ​

cards? ​

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

Valid values: all, closed, none, open, visible. Cards is a nested resource. The additional query params available are documented at Cards Nested Resource.

checkItemFields? ​

ts
optional checkItemFields?: 
  | "name"
  | "type"
  | "all"
  | "state"
  | string & object
  | "pos"
  | "due"
  | "idMember"
  | "nameData"
  | "dueReminder"
  | (
  | "name"
  | "type"
  | "all"
  | "state"
  | string & object
  | "pos"
  | "due"
  | "idMember"
  | "nameData"
  | "dueReminder")[];

The fields on the checkItem to return if checkItems are being returned. all or a comma-separated list of: name, nameData, pos, state, type, due, dueReminder, idMember

checkItems? ​

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

The check items on the list to return. One of: all, none.

fields? ​

ts
optional fields?: 
  | "name"
  | "id"
  | string & object
  | "pos"
  | "idCard"
  | "idBoard"
  | ("name" | "id" | string & object | "pos" | "idCard" | "idBoard")[];

all or a comma-separated list of checklist fields

id ​

ts
id: string;

ID of a checklist.