Skip to content

Type Alias: GetCard ​

ts
type GetCard = object;

Defined in: parameters/getCard.ts:326

Type Declaration ​

actions? ​

ts
optional actions?: string;

See the Actions Nested Resource

attachmentFields? ​

ts
optional attachmentFields?: 
  | "name"
  | "id"
  | "url"
  | "bytes"
  | string & object
  | "date"
  | "pos"
  | "idMember"
  | "edgeColor"
  | "isUpload"
  | "mimeType"
  | "previews"
  | (
  | "name"
  | "id"
  | "url"
  | "bytes"
  | string & object
  | "date"
  | "pos"
  | "idMember"
  | "edgeColor"
  | "isUpload"
  | "mimeType"
  | "previews")[];

all or a comma-separated list of attachment fields

attachments? ​

ts
optional attachments?: boolean | string & object | "cover";

true, false, or cover

board? ​

ts
optional board?: boolean;

Whether to return the board object the card is on

boardFields? ​

ts
optional boardFields?: 
  | "name"
  | "id"
  | "url"
  | "closed"
  | "desc"
  | string & object
  | "prefs"
  | "limits"
  | "idMemberCreator"
  | "memberships"
  | "descData"
  | "idOrganization"
  | "pinned"
  | "shortUrl"
  | "labelNames"
  | "starred"
  | "enterpriseOwned"
  | (
  | "name"
  | "id"
  | "url"
  | "closed"
  | "desc"
  | string & object
  | "prefs"
  | "limits"
  | "idMemberCreator"
  | "memberships"
  | "descData"
  | "idOrganization"
  | "pinned"
  | "shortUrl"
  | "labelNames"
  | "starred"
  | "enterpriseOwned")[];

all or a comma-separated list of board fields. Defaults: name, desc, descData, closed, idOrganization, pinned, url, prefs

checkItemStates? ​

ts
optional checkItemStates?: boolean;

checklistFields? ​

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

all or a comma-separated list of idBoard,idCard,name,pos

checklists? ​

ts
optional checklists?: string;

Whether to return the checklists on the card. all or none

customFieldItems? ​

ts
optional customFieldItems?: boolean;

Whether to include the customFieldItems

fields? ​

ts
optional fields?: 
  | "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 fields. Defaults: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, start, idBoard, idChecklists, idLabels, idList, idMembers, idShort, idAttachmentCover, manualCoverAttachment, labels, name, pos, shortUrl, url

id ​

ts
id: string;

The ID of the Card

list? ​

ts
optional list?: boolean;

See the Lists Nested Resource

memberFields? ​

ts
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")[];

all or a comma-separated list of member fields. Defaults: avatarHash, fullName, initials, username

members? ​

ts
optional members?: boolean;

Whether to return member objects for members on the card

membersVoted? ​

ts
optional membersVoted?: boolean;

Whether to return member objects for members who voted on the card

memberVotedFields? ​

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

all or a comma-separated list of member fields. Defaults: avatarHash, fullName, initials, username

pluginData? ​

ts
optional pluginData?: boolean;

Whether to include pluginData on the card with the response

stickerFields? ​

ts
optional stickerFields?: 
  | "id"
  | "left"
  | "top"
  | "rotate"
  | "zIndex"
  | "image"
  | string & object
  | "imageUrl"
  | "imageScaled"
  | (
  | "id"
  | "left"
  | "top"
  | "rotate"
  | "zIndex"
  | "image"
  | string & object
  | "imageUrl"
  | "imageScaled")[];

all or a comma-separated list of sticker fields

stickers? ​

ts
optional stickers?: boolean;

Whether to include sticker models with the response