Skip to content

Type Alias: Card ​

ts
type Card = object;

Defined in: models/card.ts:121

Type Declaration ​

address? ​

ts
optional address?: string | null;

agent? ​

ts
optional agent?: 
  | {
  conversationId?: string | null;
  name?: string | null;
}
  | null;

aiMetadata? ​

ts
optional aiMetadata?: unknown;

Metadata attached to the card when it was created or modified by an agent rather than a human member.

attachments? ​

ts
optional attachments?: object[];

badges? ​

ts
optional badges?: object;

badges.attachments? ​

ts
optional attachments?: number;

badges.attachmentsByType? ​

ts
optional attachmentsByType?: object;

badges.attachmentsByType.trello? ​

ts
optional trello?: object;

badges.attachmentsByType.trello.board? ​

ts
optional board?: number;

badges.attachmentsByType.trello.card? ​

ts
optional card?: number;

badges.checkItems? ​

ts
optional checkItems?: number;

badges.checkItemsChecked? ​

ts
optional checkItemsChecked?: number;

badges.checkItemsEarliestDue? ​

ts
optional checkItemsEarliestDue?: Date | null;

badges.comments? ​

ts
optional comments?: number;

badges.description? ​

ts
optional description?: boolean;

badges.due? ​

ts
optional due?: Date | null;

badges.dueComplete? ​

ts
optional dueComplete?: boolean;

badges.externalSource? ​

ts
optional externalSource?: Record<string, any> | null;

badges.fogbugz? ​

ts
optional fogbugz?: string;

badges.lastUpdatedByAi? ​

ts
optional lastUpdatedByAi?: boolean;

badges.location? ​

ts
optional location?: boolean;

badges.maliciousAttachments? ​

ts
optional maliciousAttachments?: number;

badges.start? ​

ts
optional start?: Date | null;

badges.subscribed? ​

ts
optional subscribed?: boolean;

badges.viewingMemberVoted? ​

ts
optional viewingMemberVoted?: boolean;

badges.votes? ​

ts
optional votes?: number;

cardRole? ​

ts
optional cardRole?: "link" | string & object | "board" | "separator" | "mirror" | null;

checkItemStates? ​

ts
optional checkItemStates?: object[];

closed? ​

ts
optional closed?: boolean;

coordinates? ​

ts
optional coordinates?: string | null;

cover? ​

ts
optional cover?: object;

cover.brightness? ​

ts
optional brightness?: string & object | "light" | "dark";

cover.color? ​

ts
optional color?: 
  | string & object
  | "green"
  | "yellow"
  | "orange"
  | "red"
  | "purple"
  | "blue"
  | "sky"
  | "lime"
  | "pink"
  | "black"
  | "green_light"
  | "green_dark"
  | "yellow_light"
  | "yellow_dark"
  | "orange_light"
  | "orange_dark"
  | "red_light"
  | "red_dark"
  | "purple_light"
  | "purple_dark"
  | "blue_light"
  | "blue_dark"
  | "sky_light"
  | "sky_dark"
  | "lime_light"
  | "lime_dark"
  | "pink_light"
  | "pink_dark"
  | "black_light"
  | "black_dark"
  | null;

cover.idAttachment? ​

ts
optional idAttachment?: string | null;

cover.idPlugin? ​

ts
optional idPlugin?: string | null;

cover.idUploadedBackground? ​

ts
optional idUploadedBackground?: boolean | null;

cover.isTemplate? ​

ts
optional isTemplate?: boolean;

cover.size? ​

ts
optional size?: "normal" | string & object;

cover.yPosition? ​

ts
optional yPosition?: number;

creationMethod? ​

ts
optional creationMethod?: string | null;

creationMethodError? ​

ts
optional creationMethodError?: unknown;

creationMethodLoadingStartedAt? ​

ts
optional creationMethodLoadingStartedAt?: unknown;

customFieldItems? ​

ts
optional customFieldItems?: unknown[];

dateClosed? ​

ts
optional dateClosed?: Date | null;

dateCompleted? ​

ts
optional dateCompleted?: Date | null;

dateLastActivity? ​

ts
optional dateLastActivity?: Date;

dateViewedByCreator? ​

ts
optional dateViewedByCreator?: unknown;

desc? ​

ts
optional desc?: string;

descData? ​

ts
optional descData?: object;

descData.emoji? ​

ts
optional emoji?: Record<string, any>;

due? ​

ts
optional due?: Date | null;

dueComplete? ​

ts
optional dueComplete?: boolean;

dueReminder? ​

ts
optional dueReminder?: number | null;

email? ​

ts
optional email?: string | null;

externalSource? ​

ts
optional externalSource?: unknown;

faviconUrl? ​

ts
optional faviconUrl?: unknown;

id ​

ts
id: string;

idAttachmentCover? ​

ts
optional idAttachmentCover?: string | null;

idBoard? ​

ts
optional idBoard?: string;

idChecklists? ​

ts
optional idChecklists?: (
  | string
  | {
  checkItems?: object[];
  id: string;
  idBoard?: string;
  idCard?: string;
  limits?: {
     attachments?: {
        perBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        perCard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     boards?: {
        totalAccessRequestsPerBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        totalMembersPerBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        totalPerMember?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     cards?: {
        openPerBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        openPerList?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        totalPerBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        totalPerList?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     checkItems?: {
        perChecklist?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     checklists?: {
        perBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        perCard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     customFieldOptions?: {
        perField?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     customFields?: {
        perBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     labels?: {
        perBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     lists?: {
        openPerBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        totalPerBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     orgs?: {
        freeBoardsPerOrg?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        totalMembersPerOrg?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        totalPerMember?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        usersPerFreeOrg?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     reactions?: {
        perAction?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        uniquePerAction?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     stickers?: {
        perCard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
  };
  name?: string;
  pos?: number | "top" | "bottom" | string & object;
})[];

idLabels? ​

ts
optional idLabels?: (
  | string
  | {
  color?:   | string & object
     | "green"
     | "yellow"
     | "orange"
     | "red"
     | "purple"
     | "blue"
     | "sky"
     | "lime"
     | "pink"
     | "black"
     | "green_light"
     | "green_dark"
     | "yellow_light"
     | "yellow_dark"
     | "orange_light"
     | "orange_dark"
     | "red_light"
     | "red_dark"
     | "purple_light"
     | "purple_dark"
     | "blue_light"
     | "blue_dark"
     | "sky_light"
     | "sky_dark"
     | "lime_light"
     | "lime_dark"
     | "pink_light"
     | "pink_dark"
     | "black_light"
     | "black_dark"
     | null;
  id: string;
  idBoard?: string;
  idOrganization?: string | null;
  limits?: {
     attachments?: {
        perBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        perCard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     boards?: {
        totalAccessRequestsPerBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        totalMembersPerBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        totalPerMember?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     cards?: {
        openPerBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        openPerList?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        totalPerBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        totalPerList?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     checkItems?: {
        perChecklist?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     checklists?: {
        perBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        perCard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     customFieldOptions?: {
        perField?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     customFields?: {
        perBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     labels?: {
        perBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     lists?: {
        openPerBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        totalPerBoard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     orgs?: {
        freeBoardsPerOrg?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        totalMembersPerOrg?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        totalPerMember?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        usersPerFreeOrg?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     reactions?: {
        perAction?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
        uniquePerAction?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
     stickers?: {
        perCard?: {
           count?: ...;
           disableAt: ...;
           status: ...;
           warnAt: ...;
        };
     };
  };
  name?: string | null;
  nodeId?: string;
  uses?: number;
})[];

idList? ​

ts
optional idList?: string;

idMemberCreator? ​

ts
optional idMemberCreator?: string | null;

idMembers? ​

ts
optional idMembers?: string[];

idMembersVoted? ​

ts
optional idMembersVoted?: string[];

idOrganization? ​

ts
optional idOrganization?: string | null;

idShort? ​

ts
optional idShort?: number;

isTemplate? ​

ts
optional isTemplate?: boolean;

labels? ​

ts
optional labels?: object[];

lastSummaryChangeEventAt? ​

ts
optional lastSummaryChangeEventAt?: Date | null;

limits? ​

ts
optional limits?: object;

limits.attachments? ​

ts
optional attachments?: object;

limits.attachments.perBoard? ​

ts
optional perBoard?: object;

limits.attachments.perBoard.count? ​

ts
optional count?: number;

limits.attachments.perBoard.disableAt ​

ts
disableAt: number;

limits.attachments.perBoard.status ​

ts
status: string;

limits.attachments.perBoard.warnAt ​

ts
warnAt: number;

limits.attachments.perCard? ​

ts
optional perCard?: object;

limits.attachments.perCard.count? ​

ts
optional count?: number;

limits.attachments.perCard.disableAt ​

ts
disableAt: number;

limits.attachments.perCard.status ​

ts
status: string;

limits.attachments.perCard.warnAt ​

ts
warnAt: number;

limits.boards? ​

ts
optional boards?: object;

limits.boards.totalAccessRequestsPerBoard? ​

ts
optional totalAccessRequestsPerBoard?: object;

limits.boards.totalAccessRequestsPerBoard.count? ​

ts
optional count?: number;

limits.boards.totalAccessRequestsPerBoard.disableAt ​

ts
disableAt: number;

limits.boards.totalAccessRequestsPerBoard.status ​

ts
status: string;

limits.boards.totalAccessRequestsPerBoard.warnAt ​

ts
warnAt: number;

limits.boards.totalMembersPerBoard? ​

ts
optional totalMembersPerBoard?: object;

limits.boards.totalMembersPerBoard.count? ​

ts
optional count?: number;

limits.boards.totalMembersPerBoard.disableAt ​

ts
disableAt: number;

limits.boards.totalMembersPerBoard.status ​

ts
status: string;

limits.boards.totalMembersPerBoard.warnAt ​

ts
warnAt: number;

limits.boards.totalPerMember? ​

ts
optional totalPerMember?: object;

limits.boards.totalPerMember.count? ​

ts
optional count?: number;

limits.boards.totalPerMember.disableAt ​

ts
disableAt: number;

limits.boards.totalPerMember.status ​

ts
status: string;

limits.boards.totalPerMember.warnAt ​

ts
warnAt: number;

limits.cards? ​

ts
optional cards?: object;

limits.cards.openPerBoard? ​

ts
optional openPerBoard?: object;

limits.cards.openPerBoard.count? ​

ts
optional count?: number;

limits.cards.openPerBoard.disableAt ​

ts
disableAt: number;

limits.cards.openPerBoard.status ​

ts
status: string;

limits.cards.openPerBoard.warnAt ​

ts
warnAt: number;

limits.cards.openPerList? ​

ts
optional openPerList?: object;

limits.cards.openPerList.count? ​

ts
optional count?: number;

limits.cards.openPerList.disableAt ​

ts
disableAt: number;

limits.cards.openPerList.status ​

ts
status: string;

limits.cards.openPerList.warnAt ​

ts
warnAt: number;

limits.cards.totalPerBoard? ​

ts
optional totalPerBoard?: object;

limits.cards.totalPerBoard.count? ​

ts
optional count?: number;

limits.cards.totalPerBoard.disableAt ​

ts
disableAt: number;

limits.cards.totalPerBoard.status ​

ts
status: string;

limits.cards.totalPerBoard.warnAt ​

ts
warnAt: number;

limits.cards.totalPerList? ​

ts
optional totalPerList?: object;

limits.cards.totalPerList.count? ​

ts
optional count?: number;

limits.cards.totalPerList.disableAt ​

ts
disableAt: number;

limits.cards.totalPerList.status ​

ts
status: string;

limits.cards.totalPerList.warnAt ​

ts
warnAt: number;

limits.checkItems? ​

ts
optional checkItems?: object;

limits.checkItems.perChecklist? ​

ts
optional perChecklist?: object;

limits.checkItems.perChecklist.count? ​

ts
optional count?: number;

limits.checkItems.perChecklist.disableAt ​

ts
disableAt: number;

limits.checkItems.perChecklist.status ​

ts
status: string;

limits.checkItems.perChecklist.warnAt ​

ts
warnAt: number;

limits.checklists? ​

ts
optional checklists?: object;

limits.checklists.perBoard? ​

ts
optional perBoard?: object;

limits.checklists.perBoard.count? ​

ts
optional count?: number;

limits.checklists.perBoard.disableAt ​

ts
disableAt: number;

limits.checklists.perBoard.status ​

ts
status: string;

limits.checklists.perBoard.warnAt ​

ts
warnAt: number;

limits.checklists.perCard? ​

ts
optional perCard?: object;

limits.checklists.perCard.count? ​

ts
optional count?: number;

limits.checklists.perCard.disableAt ​

ts
disableAt: number;

limits.checklists.perCard.status ​

ts
status: string;

limits.checklists.perCard.warnAt ​

ts
warnAt: number;

limits.customFieldOptions? ​

ts
optional customFieldOptions?: object;

limits.customFieldOptions.perField? ​

ts
optional perField?: object;

limits.customFieldOptions.perField.count? ​

ts
optional count?: number;

limits.customFieldOptions.perField.disableAt ​

ts
disableAt: number;

limits.customFieldOptions.perField.status ​

ts
status: string;

limits.customFieldOptions.perField.warnAt ​

ts
warnAt: number;

limits.customFields? ​

ts
optional customFields?: object;

limits.customFields.perBoard? ​

ts
optional perBoard?: object;

limits.customFields.perBoard.count? ​

ts
optional count?: number;

limits.customFields.perBoard.disableAt ​

ts
disableAt: number;

limits.customFields.perBoard.status ​

ts
status: string;

limits.customFields.perBoard.warnAt ​

ts
warnAt: number;

limits.labels? ​

ts
optional labels?: object;

limits.labels.perBoard? ​

ts
optional perBoard?: object;

limits.labels.perBoard.count? ​

ts
optional count?: number;

limits.labels.perBoard.disableAt ​

ts
disableAt: number;

limits.labels.perBoard.status ​

ts
status: string;

limits.labels.perBoard.warnAt ​

ts
warnAt: number;

limits.lists? ​

ts
optional lists?: object;

limits.lists.openPerBoard? ​

ts
optional openPerBoard?: object;

limits.lists.openPerBoard.count? ​

ts
optional count?: number;

limits.lists.openPerBoard.disableAt ​

ts
disableAt: number;

limits.lists.openPerBoard.status ​

ts
status: string;

limits.lists.openPerBoard.warnAt ​

ts
warnAt: number;

limits.lists.totalPerBoard? ​

ts
optional totalPerBoard?: object;

limits.lists.totalPerBoard.count? ​

ts
optional count?: number;

limits.lists.totalPerBoard.disableAt ​

ts
disableAt: number;

limits.lists.totalPerBoard.status ​

ts
status: string;

limits.lists.totalPerBoard.warnAt ​

ts
warnAt: number;

limits.orgs? ​

ts
optional orgs?: object;

limits.orgs.freeBoardsPerOrg? ​

ts
optional freeBoardsPerOrg?: object;

limits.orgs.freeBoardsPerOrg.count? ​

ts
optional count?: number;

limits.orgs.freeBoardsPerOrg.disableAt ​

ts
disableAt: number;

limits.orgs.freeBoardsPerOrg.status ​

ts
status: string;

limits.orgs.freeBoardsPerOrg.warnAt ​

ts
warnAt: number;

limits.orgs.totalMembersPerOrg? ​

ts
optional totalMembersPerOrg?: object;

limits.orgs.totalMembersPerOrg.count? ​

ts
optional count?: number;

limits.orgs.totalMembersPerOrg.disableAt ​

ts
disableAt: number;

limits.orgs.totalMembersPerOrg.status ​

ts
status: string;

limits.orgs.totalMembersPerOrg.warnAt ​

ts
warnAt: number;

limits.orgs.totalPerMember? ​

ts
optional totalPerMember?: object;

limits.orgs.totalPerMember.count? ​

ts
optional count?: number;

limits.orgs.totalPerMember.disableAt ​

ts
disableAt: number;

limits.orgs.totalPerMember.status ​

ts
status: string;

limits.orgs.totalPerMember.warnAt ​

ts
warnAt: number;

limits.orgs.usersPerFreeOrg? ​

ts
optional usersPerFreeOrg?: object;

limits.orgs.usersPerFreeOrg.count? ​

ts
optional count?: number;

limits.orgs.usersPerFreeOrg.disableAt ​

ts
disableAt: number;

limits.orgs.usersPerFreeOrg.status ​

ts
status: string;

limits.orgs.usersPerFreeOrg.warnAt ​

ts
warnAt: number;

limits.reactions? ​

ts
optional reactions?: object;

limits.reactions.perAction? ​

ts
optional perAction?: object;

limits.reactions.perAction.count? ​

ts
optional count?: number;

limits.reactions.perAction.disableAt ​

ts
disableAt: number;

limits.reactions.perAction.status ​

ts
status: string;

limits.reactions.perAction.warnAt ​

ts
warnAt: number;

limits.reactions.uniquePerAction? ​

ts
optional uniquePerAction?: object;

limits.reactions.uniquePerAction.count? ​

ts
optional count?: number;

limits.reactions.uniquePerAction.disableAt ​

ts
disableAt: number;

limits.reactions.uniquePerAction.status ​

ts
status: string;

limits.reactions.uniquePerAction.warnAt ​

ts
warnAt: number;

limits.stickers? ​

ts
optional stickers?: object;

limits.stickers.perCard? ​

ts
optional perCard?: object;

limits.stickers.perCard.count? ​

ts
optional count?: number;

limits.stickers.perCard.disableAt ​

ts
disableAt: number;

limits.stickers.perCard.status ​

ts
status: string;

limits.stickers.perCard.warnAt ​

ts
warnAt: number;

locationName? ​

ts
optional locationName?: string | null;

manifest? ​

ts
optional manifest?: unknown;

manualCoverAttachment? ​

ts
optional manualCoverAttachment?: boolean;

members? ​

ts
optional members?: object[];

membersVoted? ​

ts
optional membersVoted?: object[];

mirrorSourceId? ​

ts
optional mirrorSourceId?: string | null;

mirrorSourceNodeId? ​

ts
optional mirrorSourceNodeId?: unknown;

name? ​

ts
optional name?: string;

nodeId? ​

ts
optional nodeId?: string;

originalDesc? ​

ts
optional originalDesc?: string | null;

originalName? ​

ts
optional originalName?: string | null;

pinned? ​

ts
optional pinned?: boolean;

pluginData? ​

ts
optional pluginData?: unknown[];

pos? ​

ts
optional pos?: number;

recurrenceRule? ​

ts
optional recurrenceRule?: unknown;
ts
optional shortLink?: string;

shortUrl? ​

ts
optional shortUrl?: string;

singleInstrumentationId? ​

ts
optional singleInstrumentationId?: unknown;

sourceEmail? ​

ts
optional sourceEmail?: unknown;

start? ​

ts
optional start?: Date | null;

staticMapUrl? ​

ts
optional staticMapUrl?: unknown;

stickers? ​

ts
optional stickers?: object[];

subscribed? ​

ts
optional subscribed?: boolean;

url? ​

ts
optional url?: string;

urlSource? ​

ts
optional urlSource?: string | null;

urlSourceText? ​

ts
optional urlSourceText?: unknown;