Class CardItem

Hierarchy

BaseCardItem
- CardItem

Index

Properties

boardId createdAt? createdBy? data? geometry? id links? modifiedAt? modifiedBy? parent? position? style? type

Methods

connectTo attachTag delete getAllTags removeTag update

Properties

boardId

boardId: string

`Optional` createdAt

createdAt?: Date

Date and time when the item was created.
Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

`Optional` createdBy

createdBy?: CreatedBy

`Optional` data

data?: CardData

`Optional` geometry

geometry?: Geometry

id

id: string

Unique identifier (ID) of an item.

`Optional` links

links?: WidgetLinks

`Optional` modifiedAt

modifiedAt?: Date

Date and time when the item was last modified.
Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

`Optional` modifiedBy

modifiedBy?: ModifiedBy

`Optional` parent

parent?: ParentLinksEnvelope

`Optional` position

position?: Position

`Optional` style

style?: CardStyle

type

type: "card" = 'card'

Type of item that is returned.

Methods

connectTo

connectTo: ((endItem: string | number | ItemConnectionCreationData, connectorCreationData?: ConnectorCreationData) => Promise<Connector>) = ConnectableItem.prototype.connectTo

Type declaration

- (endItem: string | number | ItemConnectionCreationData, connectorCreationData?: ConnectorCreationData): Promise<Connector>
- Parameters
  - endItem: string | number | ItemConnectionCreationData
  - Optional connectorCreationData: ConnectorCreationData
  Returns Promise<Connector>

attachTag

attachTag(tagId: string): Promise<void>
Attach an existing tag to the specified item. Card and sticky note items can have up to 8 tags.
Note: Updates to tags made via the REST API will not be reflected on the board in realtime. To see REST API updates to tags on a board, you need to refresh the board. This applies to the following endpoints: Remove tag from item, Update tag, Delete tag.

Required scope
boards:write
Rate limiting
Level 1

Summary
Attach tag to item
Parameters
- tagId: string
  
  Unique identifier (ID) of the tag you want to add to the item.
Returns Promise<void>
- Defined in highlevel/index.ts:943

delete

delete(): Promise<void>
Deletes a card item from the board.
Required scope
boards:write
Rate limiting
Level 3

Summary
Delete card item

Returns Promise<void>
- Defined in highlevel/index.ts:911

getAllTags

getAllTags(): Promise<Tag[]>
Retrieves all the tags from the specified item.
Required scope
boards:read
Rate limiting
Level 1

Summary
Get tags from item

Returns Promise<Tag[]>
- Defined in highlevel/index.ts:919

removeTag

removeTag(tagId: string): Promise<void>
Removes the specified tag from the specified item. The tag still exists on the board.
Note: Updates to tags made via the REST API will not be reflected on the board in realtime. To see REST API updates to tags on a board, you need to refresh the board. This applies to the following endpoints: Attach tag to item, Update tag, Delete tag.

Required scope
boards:write
Rate limiting
Level 1

Summary
Remove tag from item
Parameters
- tagId: string
  
  Unique identifier (ID) of the tag that you want to remove from the item.
Returns Promise<void>
- Defined in highlevel/index.ts:934

update

update(cardUpdateRequest: CardUpdateRequest): Promise<void>
Updates a card item on a board based on the data and style properties provided in the request body.
Required scope
boards:write
Rate limiting
Level 2

Summary
Update card item
Parameters
- cardUpdateRequest: CardUpdateRequest
Returns Promise<void>
- Defined in highlevel/index.ts:903