Schemas

Typed JSON schemas for all Planka objects

CLASS	DESCRIPTION
Action
Attachment
BackgroundImage
BaseCustomFieldGroup
Board
BoardMembership
Card
CardLabel
CardMembership
Comment
Config
CustomField
CustomFieldGroup
CustomFieldValue
Label
List
Notification
NotificationService
Project
ProjectManager
Stopwatch
Task
TaskList
User
Webhook

Action

Bases: TypedDict

Returned by:

• Plankapy v2
  • Planka Utilities  PlankaSnapshot  actions
  • api REST Typing
    •  Included_moveListCards  actions
    •  Response_getBoardActions  items
    •  Response_getCardActions  items

Subclassed by:

• Plankapy v2 models Action  Action

ATTRIBUTE	DESCRIPTION
boardId	ID of the board where the action occurred TYPE: str
cardId	ID of the card where the action occurred TYPE: str
createdAt	When the action was created TYPE: str
data	Action specific data (varies by type) TYPE: dict[str, Any]
id	Unique identifier for the action TYPE: str
type	Type of the action TYPE: Literal['createCard', 'moveCard', 'addMemberToCard', 'removeMemberFromCard', 'completeTask', 'uncompleteTask']
updatedAt	When the action was last updated TYPE: str
userId	ID of the user who performed the action TYPE: str

boardId instance-attribute

boardId: str

ID of the board where the action occurred

cardId instance-attribute

cardId: str

ID of the card where the action occurred

createdAt instance-attribute

createdAt: str

When the action was created

data instance-attribute

data: dict[str, Any]

Action specific data (varies by type)

id instance-attribute

id: str

Unique identifier for the action

type instance-attribute

type: Literal['createCard', 'moveCard', 'addMemberToCard', 'removeMemberFromCard', 'completeTask', 'uncompleteTask']

Type of the action

updatedAt instance-attribute

updatedAt: str

When the action was last updated

userId instance-attribute

userId: str

ID of the user who performed the action

Attachment

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing
  •  Included_duplicateCard  attachments
  •  Included_getBoard  attachments
  •  Included_getCard  attachments
  •  Included_getCards  attachments
  •  Included_getList  attachments
  •  Response_createAttachment  item
  •  Response_deleteAttachment  item
  •  Response_updateAttachment  item

Subclassed by:

• Plankapy v2 models Attachment  Attachment

ATTRIBUTE	DESCRIPTION
cardId	ID of the card the attachment belongs to TYPE: str
createdAt	When the attachment was created TYPE: str
creatorUserId	ID of the user who created the attachment TYPE: str
data	Attachment specific data (varies by type) TYPE: dict[str, Any]
id	Unique identifier for the attachment TYPE: str
name	Name/title of the attachment TYPE: str
type	Type of the attachment TYPE: Literal['file', 'link']
updatedAt	When the attachment was last updated TYPE: str

cardId instance-attribute

cardId: str

ID of the card the attachment belongs to

createdAt instance-attribute

createdAt: str

When the attachment was created

creatorUserId instance-attribute

creatorUserId: str

ID of the user who created the attachment

data instance-attribute

data: dict[str, Any]

Attachment specific data (varies by type)

id instance-attribute

id: str

Unique identifier for the attachment

name instance-attribute

name: str

Name/title of the attachment

type instance-attribute

type: Literal['file', 'link']

Type of the attachment

updatedAt instance-attribute

updatedAt: str

When the attachment was last updated

BackgroundImage

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing
  •  Included_getProject  backgroundImages
  •  Included_getProjects  backgroundImages
  •  Response_createBackgroundImage  item
  •  Response_deleteBackgroundImage  item

Subclassed by:

• Plankapy v2 models Background Image  BackgroundImage

ATTRIBUTE	DESCRIPTION
createdAt	When the background image was created TYPE: str
id	Unique identifier for the background image TYPE: str
projectId	ID of the project the background image belongs to TYPE: str
sizeInBytes	File size of the background image in bytes TYPE: str
thumbnailUrls	URLs for different thumbnail sizes of the background image TYPE: dict[str, Any]
updatedAt	When the background image was last updated TYPE: str
url	URL to access the full-size background image TYPE: str

createdAt instance-attribute

createdAt: str

When the background image was created

id instance-attribute

id: str

Unique identifier for the background image

projectId instance-attribute

projectId: str

ID of the project the background image belongs to

sizeInBytes instance-attribute

sizeInBytes: str

File size of the background image in bytes

thumbnailUrls instance-attribute

thumbnailUrls: dict[str, Any]

URLs for different thumbnail sizes of the background image

updatedAt instance-attribute

updatedAt: str

When the background image was last updated

url instance-attribute

url: str

URL to access the full-size background image

BaseCustomFieldGroup

Bases: TypedDict

Returned by:

• Plankapy v2
  • Planka Utilities  PlankaSnapshot  base_custom_field_groups
  • api REST Typing
    •  Included_getProject  baseCustomFieldGroups
    •  Included_getProjects  baseCustomFieldGroups
    •  Response_createBaseCustomFieldGroup  item
    •  Response_deleteBaseCustomFieldGroup  item
    •  Response_updateBaseCustomFieldGroup  item

Subclassed by:

• Plankapy v2 models Base Custom Field Group  BaseCustomFieldGroup

ATTRIBUTE	DESCRIPTION
createdAt	When the base custom field group was created TYPE: str
id	Unique identifier for the base custom field group TYPE: str
name	Name/title of the base custom field group TYPE: str
projectId	ID of the project the base custom field group belongs to TYPE: str
updatedAt	When the base custom field group was last updated TYPE: str

createdAt instance-attribute

createdAt: str

When the base custom field group was created

id instance-attribute

id: str

Unique identifier for the base custom field group

name instance-attribute

name: str

Name/title of the base custom field group

projectId instance-attribute

projectId: str

ID of the project the base custom field group belongs to

updatedAt instance-attribute

updatedAt: str

When the base custom field group was last updated

Board

Bases: TypedDict

Returned by:

• Plankapy v2
  • Planka Utilities  PlankaSnapshot  boards
  • api REST Typing
    •  Included_getProject  boards
    •  Included_getProjects  boards
    •  Response_createBoard  item
    •  Response_deleteBoard  item
    •  Response_updateBoard  item

Subclassed by:

• Plankapy v2
  • models Board  Board
  • api REST Typing  Item_getBoard

ATTRIBUTE	DESCRIPTION
alwaysDisplayCardCreator	Whether to always display the card creator TYPE: bool
createdAt	When the board was created TYPE: str
defaultCardType	Default card type for new cards TYPE: Literal['project', 'story']
defaultView	Default view for the board TYPE: Literal['kanban', 'grid', 'list']
expandTaskListsByDefault	Whether to expand task lists by default TYPE: bool
id	Unique identifier for the board TYPE: str
limitCardTypesToDefaultOne	Whether to limit card types to default one TYPE: bool
name	Name/title of the board TYPE: str
position	Position of the board within the project TYPE: int
projectId	ID of the project the board belongs to TYPE: str
updatedAt	When the board was last updated TYPE: str

alwaysDisplayCardCreator instance-attribute

alwaysDisplayCardCreator: bool

Whether to always display the card creator

createdAt instance-attribute

createdAt: str

When the board was created

defaultCardType instance-attribute

defaultCardType: Literal['project', 'story']

Default card type for new cards

defaultView instance-attribute

defaultView: Literal['kanban', 'grid', 'list']

Default view for the board

expandTaskListsByDefault instance-attribute

expandTaskListsByDefault: bool

Whether to expand task lists by default

id instance-attribute

id: str

Unique identifier for the board

limitCardTypesToDefaultOne instance-attribute

limitCardTypesToDefaultOne: bool

Whether to limit card types to default one

name instance-attribute

name: str

Name/title of the board

position instance-attribute

position: int

Position of the board within the project

projectId instance-attribute

projectId: str

ID of the project the board belongs to

updatedAt instance-attribute

updatedAt: str

When the board was last updated

BoardMembership

Bases: TypedDict

Returned by:

• Plankapy v2
  • Planka Utilities  PlankaSnapshot  board_memberships
  • api REST Typing
    •  Included_createBoard  boardMemberships
    •  Included_getBoard  boardMemberships
    •  Included_getProject  boardMemberships
    •  Included_getProjects  boardMemberships
    •  Response_createBoardMembership  item
    •  Response_deleteBoardMembership  item
    •  Response_updateBoardMembership  item

Subclassed by:

• Plankapy v2 models Board Membership  BoardMembership

ATTRIBUTE	DESCRIPTION
boardId	ID of the board the membership is associated with TYPE: str
canComment	Whether the user can comment on cards (applies only to viewers) TYPE: bool
createdAt	When the board membership was created TYPE: str
id	Unique identifier for the board membership TYPE: str
projectId	ID of the project the board membership belongs to (denormalized) TYPE: str
role	Role of the user in the board TYPE: Literal['editor', 'viewer']
updatedAt	When the board membership was last updated TYPE: str
userId	ID of the user who is a member of the board TYPE: str

boardId instance-attribute

boardId: str

ID of the board the membership is associated with

canComment instance-attribute

canComment: bool

Whether the user can comment on cards (applies only to viewers)

createdAt instance-attribute

createdAt: str

When the board membership was created

id instance-attribute

id: str

Unique identifier for the board membership

projectId instance-attribute

projectId: str

ID of the project the board membership belongs to (denormalized)

role instance-attribute

role: Literal['editor', 'viewer']

Role of the user in the board

updatedAt instance-attribute

updatedAt: str

When the board membership was last updated

userId instance-attribute

userId: str

ID of the user who is a member of the board

Card

Bases: TypedDict

Returned by:

• Plankapy v2
  • Planka Utilities  PlankaSnapshot  cards
  • api REST Typing
    •  Included_deleteList  cards
    •  Included_moveListCards  cards
    •  Included_sortList  cards
    •  Response_createCard  item
    •  Response_deleteCard  item
    •  Response_duplicateCard  item
    •  Response_readCardNotifications  item
    •  Response_updateCard  item

Subclassed by:

• Plankapy v2
  • models Card  Card
  • api REST Typing
    •  Included_getBoard_all
    •  Included_getList_all
    •  Item_getCard
    •  Items_getCards

ATTRIBUTE	DESCRIPTION
boardId	ID of the board the card belongs to (denormalized) TYPE: str
commentsTotal	Total number of comments on the card TYPE: int
coverAttachmentId	ID of the attachment used as cover TYPE: str
createdAt	When the card was created TYPE: str
creatorUserId	ID of the user who created the card TYPE: str
description	Detailed description of the card TYPE: str
dueDate	Due date for the card TYPE: str
id	Unique identifier for the card TYPE: str
isClosed	Whether the card is closed TYPE: bool
isDueCompleted	Whether the due date is completed TYPE: bool
listChangedAt	When the card was last moved between lists TYPE: str
listId	ID of the list the card belongs to TYPE: str
name	Name/title of the card TYPE: str
position	Position of the card within the list TYPE: int
prevListId	ID of the previous list the card was in (available when in archive or trash) TYPE: str
stopwatch	Stopwatch data for time tracking TYPE: Stopwatch | None
type	Type of the card TYPE: Literal['project', 'story']
updatedAt	When the card was last updated TYPE: str

boardId instance-attribute

boardId: str

ID of the board the card belongs to (denormalized)

commentsTotal instance-attribute

commentsTotal: int

Total number of comments on the card

coverAttachmentId instance-attribute

coverAttachmentId: str

ID of the attachment used as cover

createdAt instance-attribute

createdAt: str

When the card was created

creatorUserId instance-attribute

creatorUserId: str

ID of the user who created the card

description instance-attribute

description: str

Detailed description of the card

dueDate instance-attribute

dueDate: str

Due date for the card

id instance-attribute

id: str

Unique identifier for the card

isClosed instance-attribute

isClosed: bool

Whether the card is closed

isDueCompleted instance-attribute

isDueCompleted: bool

Whether the due date is completed

listChangedAt instance-attribute

listChangedAt: str

When the card was last moved between lists

listId instance-attribute

listId: str

ID of the list the card belongs to

name instance-attribute

name: str

Name/title of the card

position instance-attribute

position: int

Position of the card within the list

prevListId instance-attribute

prevListId: str

ID of the previous list the card was in (available when in archive or trash)

stopwatch instance-attribute

stopwatch: Stopwatch | None

Stopwatch data for time tracking

type instance-attribute

type: Literal['project', 'story']

Type of the card

updatedAt instance-attribute

updatedAt: str

When the card was last updated

CardLabel

Bases: TypedDict

Returned by:

• Plankapy v2
  • Planka Utilities  PlankaSnapshot  card_labels
  • api REST Typing
    •  Included_duplicateCard  cardLabels
    •  Included_getBoard  cardLabels
    •  Included_getCard  cardLabels
    •  Included_getCards  cardLabels
    •  Included_getList  cardLabels
    •  Response_createCardLabel  item
    •  Response_deleteCardLabel  item

Subclassed by:

• Plankapy v2 models Card Label  CardLabel

ATTRIBUTE	DESCRIPTION
cardId	ID of the card the label is associated with TYPE: str
createdAt	When the card-label association was created TYPE: str
id	Unique identifier for the card-label association TYPE: str
labelId	ID of the label associated with the card TYPE: str
updatedAt	When the card-label association was last updated TYPE: str

cardId instance-attribute

cardId: str

ID of the card the label is associated with

createdAt instance-attribute

createdAt: str

When the card-label association was created

id instance-attribute

id: str

Unique identifier for the card-label association

labelId instance-attribute

labelId: str

ID of the label associated with the card

updatedAt instance-attribute

updatedAt: str

When the card-label association was last updated

CardMembership

Bases: TypedDict

Returned by:

• Plankapy v2
  • Planka Utilities  PlankaSnapshot  card_memberships
  • api REST Typing
    •  Included_duplicateCard  cardMemberships
    •  Included_getBoard  cardMemberships
    •  Included_getCard  cardMemberships
    •  Included_getCards  cardMemberships
    •  Included_getList  cardMemberships
    •  Response_createCardMembership  item
    •  Response_deleteCardMembership  item

Subclassed by:

• Plankapy v2 models Card Membership  CardMembership

ATTRIBUTE	DESCRIPTION
cardId	ID of the card the user is a member of TYPE: str
createdAt	When the card membership was created TYPE: str
id	Unique identifier for the card membership TYPE: str
updatedAt	When the card membership was last updated TYPE: str
userId	ID of the user who is a member of the card TYPE: str

cardId instance-attribute

cardId: str

ID of the card the user is a member of

createdAt instance-attribute

createdAt: str

When the card membership was created

id instance-attribute

id: str

Unique identifier for the card membership

updatedAt instance-attribute

updatedAt: str

When the card membership was last updated

userId instance-attribute

userId: str

ID of the user who is a member of the card

Comment

Bases: TypedDict

Returned by:

• Plankapy v2
  • Planka Utilities  PlankaSnapshot  comments
  • api REST Typing
    •  Response_createComment  item
    •  Response_deleteComment  item
    •  Response_getComments  items
    •  Response_updateComments  item

Subclassed by:

• Plankapy v2 models Comment  Comment

ATTRIBUTE	DESCRIPTION
cardId	ID of the card the comment belongs to TYPE: str
createdAt	When the comment was created TYPE: str
id	Unique identifier for the comment TYPE: str
text	Content of the comment TYPE: str
updatedAt	When the comment was last updated TYPE: str
userId	ID of the user who created the comment TYPE: str

cardId instance-attribute

cardId: str

ID of the card the comment belongs to

createdAt instance-attribute

createdAt: str

When the comment was created

id instance-attribute

id: str

Unique identifier for the comment

text instance-attribute

text: str

Content of the comment

updatedAt instance-attribute

updatedAt: str

When the comment was last updated

userId instance-attribute

userId: str

ID of the user who created the comment

Config

Bases: TypedDict

Returned by:

• Plankapy v2
  • Planka Utilities  PlankaSnapshot  config
  • api REST Typing  Response_getConfig  item

Subclassed by:

• Plankapy v2 models Config  Config

ATTRIBUTE	DESCRIPTION
activeUsersLimit	Maximum number of active users allowed (conditionally added for admins if configured) TYPE: NotRequired[int]
oidc	OpenID Connect configuration (null if not configured) TYPE: dict[str, Any]
version	Current version of the PLANKA application TYPE: str

activeUsersLimit instance-attribute

activeUsersLimit: NotRequired[int]

Maximum number of active users allowed (conditionally added for admins if configured)

oidc instance-attribute

oidc: dict[str, Any]

OpenID Connect configuration (null if not configured)

version instance-attribute

version: str

Current version of the PLANKA application

CustomField

Bases: TypedDict

Returned by:

• Plankapy v2
  • Planka Utilities  PlankaSnapshot  custom_fields
  • api REST Typing
    •  Included_duplicateCard  customFields
    •  Included_getBoard  customFields
    •  Included_getCard  customFields
    •  Included_getCards  customFields
    •  Included_getCustomFieldGroup  customFields
    •  Included_getList  customFields
    •  Included_getProject  customFields
    •  Included_getProjects  customFields
    •  Response_createCustomFieldInBaseGroup  item
    •  Response_createCustomFieldInGroup  item
    •  Response_deleteCustomField  item
    •  Response_updateCustomField  item

Subclassed by:

• Plankapy v2 models Custom Field  CustomField

ATTRIBUTE	DESCRIPTION
baseCustomFieldGroupId	ID of the base custom field group the custom field belongs to TYPE: str
createdAt	When the custom field was created TYPE: str
customFieldGroupId	ID of the custom field group the custom field belongs to TYPE: str
id	Unique identifier for the custom field TYPE: str
name	Name/title of the custom field TYPE: str
position	Position of the custom field within the group TYPE: int
showOnFrontOfCard	Whether to show the field on the front of cards TYPE: bool
updatedAt	When the custom field was last updated TYPE: str

baseCustomFieldGroupId instance-attribute

baseCustomFieldGroupId: str

ID of the base custom field group the custom field belongs to

createdAt instance-attribute

createdAt: str

When the custom field was created

customFieldGroupId instance-attribute

customFieldGroupId: str

ID of the custom field group the custom field belongs to

id instance-attribute

id: str

Unique identifier for the custom field

name instance-attribute

name: str

Name/title of the custom field

position instance-attribute

position: int

Position of the custom field within the group

showOnFrontOfCard instance-attribute

showOnFrontOfCard: bool

Whether to show the field on the front of cards

updatedAt instance-attribute

updatedAt: str

When the custom field was last updated

CustomFieldGroup

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing
  •  Included_duplicateCard  customFieldGroups
  •  Included_getBoard  customFieldGroups
  •  Included_getCard  customFieldGroups
  •  Included_getCards  customFieldGroups
  •  Included_getList  customFieldGroups
  •  Response_createBoardCustomFieldGroup  item
  •  Response_createCardCustomFieldGroup  item
  •  Response_deleteCustomFieldGroup  item
  •  Response_getCustomFieldGroup  item
  •  Response_updateCustomFieldGroup  item

Subclassed by:

• Plankapy v2 models Custom Field Group  CustomFieldGroup

ATTRIBUTE	DESCRIPTION
baseCustomFieldGroupId	ID of the base custom field group used as a template TYPE: str
boardId	ID of the board the custom field group belongs to TYPE: str
cardId	ID of the card the custom field group belongs to TYPE: str
createdAt	When the custom field group was created TYPE: str
id	Unique identifier for the custom field group TYPE: str
name	Name/title of the custom field group TYPE: str
position	Position of the custom field group within the board/card TYPE: int
updatedAt	When the custom field group was last updated TYPE: str

baseCustomFieldGroupId instance-attribute

baseCustomFieldGroupId: str

ID of the base custom field group used as a template

boardId instance-attribute

boardId: str

ID of the board the custom field group belongs to

cardId instance-attribute

cardId: str

ID of the card the custom field group belongs to

createdAt instance-attribute

createdAt: str

When the custom field group was created

id instance-attribute

id: str

Unique identifier for the custom field group

name instance-attribute

name: str

Name/title of the custom field group

position instance-attribute

position: int

Position of the custom field group within the board/card

updatedAt instance-attribute

updatedAt: str

When the custom field group was last updated

CustomFieldValue

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing
  •  Included_duplicateCard  customFieldValues
  •  Included_getBoard  customFieldValues
  •  Included_getCard  customFieldValues
  •  Included_getCards  customFieldValues
  •  Included_getCustomFieldGroup  customFieldValues
  •  Included_getList  customFieldValues
  •  Response_deleteCustomFieldValue  item
  •  Response_updateCustomFieldValue  item

Subclassed by:

• Plankapy v2 models Custom Field Value  CustomFieldValue

ATTRIBUTE	DESCRIPTION
cardId	ID of the card the value belongs to TYPE: str
content	Content/value of the custom field TYPE: str
createdAt	When the custom field value was created TYPE: str
customFieldGroupId	ID of the custom field group the value belongs to TYPE: str
customFieldId	ID of the custom field the value belongs to TYPE: str
id	Unique identifier for the custom field value TYPE: str
updatedAt	When the custom field value was last updated TYPE: str

cardId instance-attribute

cardId: str

ID of the card the value belongs to

content instance-attribute

content: str

Content/value of the custom field

createdAt instance-attribute

createdAt: str

When the custom field value was created

customFieldGroupId instance-attribute

customFieldGroupId: str

ID of the custom field group the value belongs to

customFieldId instance-attribute

customFieldId: str

ID of the custom field the value belongs to

id instance-attribute

id: str

Unique identifier for the custom field value

updatedAt instance-attribute

updatedAt: str

When the custom field value was last updated

Label

Bases: TypedDict

Returned by:

• Plankapy v2
  • Planka Utilities  PlankaSnapshot  labels
  • api REST Typing
    •  Included_getBoard  labels
    •  Response_createLabel  item
    •  Response_deleteLabel  item
    •  Response_updateLabel  item

Subclassed by:

• Plankapy v2 models Label  Label

ATTRIBUTE	DESCRIPTION
boardId	ID of the board the label belongs to TYPE: str
color	Color of the label TYPE: Literal['muddy-grey', 'autumn-leafs', 'morning-sky', 'antique-blue', 'egg-yellow', 'desert-sand', 'dark-granite', 'fresh-salad', 'lagoon-blue', 'midnight-blue', 'light-orange', 'pumpkin-orange', 'light-concrete', 'sunny-grass', 'navy-blue', 'lilac-eyes', 'apricot-red', 'orange-peel', 'silver-glint', 'bright-moss', 'deep-ocean', 'summer-sky', 'berry-red', 'light-cocoa', 'grey-stone', 'tank-green', 'coral-green', 'sugar-plum', 'pink-tulip', 'shady-rust', 'wet-rock', 'wet-moss', 'turquoise-sea', 'lavender-fields', 'piggy-red', 'light-mud', 'gun-metal', 'modern-green', 'french-coast', 'sweet-lilac', 'red-burgundy', 'pirate-gold']
createdAt	When the label was created TYPE: str
id	Unique identifier for the label TYPE: str
name	Name/title of the label TYPE: str
position	Position of the label within the board TYPE: int
updatedAt	When the label was last updated TYPE: str

boardId instance-attribute

boardId: str

ID of the board the label belongs to

color instance-attribute

color: Literal['muddy-grey', 'autumn-leafs', 'morning-sky', 'antique-blue', 'egg-yellow', 'desert-sand', 'dark-granite', 'fresh-salad', 'lagoon-blue', 'midnight-blue', 'light-orange', 'pumpkin-orange', 'light-concrete', 'sunny-grass', 'navy-blue', 'lilac-eyes', 'apricot-red', 'orange-peel', 'silver-glint', 'bright-moss', 'deep-ocean', 'summer-sky', 'berry-red', 'light-cocoa', 'grey-stone', 'tank-green', 'coral-green', 'sugar-plum', 'pink-tulip', 'shady-rust', 'wet-rock', 'wet-moss', 'turquoise-sea', 'lavender-fields', 'piggy-red', 'light-mud', 'gun-metal', 'modern-green', 'french-coast', 'sweet-lilac', 'red-burgundy', 'pirate-gold']

Color of the label

createdAt instance-attribute

createdAt: str

When the label was created

id instance-attribute

id: str

Unique identifier for the label

name instance-attribute

name: str

Name/title of the label

position instance-attribute

position: int

Position of the label within the board

updatedAt instance-attribute

updatedAt: str

When the label was last updated

List

Bases: TypedDict

Returned by:

• Plankapy v2
  • Planka Utilities  PlankaSnapshot  lists
  • api REST Typing
    •  Included_getBoard  lists
    •  Response_clearList  item
    •  Response_createList  item
    •  Response_deleteList  item
    •  Response_getList  item
    •  Response_moveListCards  item
    •  Response_sortList  item
    •  Response_updateList  item

Subclassed by:

• Plankapy v2 models List  List

ATTRIBUTE	DESCRIPTION
boardId	ID of the board the list belongs to TYPE: str
color	Color for the list TYPE: Literal['berry-red', 'pumpkin-orange', 'lagoon-blue', 'pink-tulip', 'light-mud', 'orange-peel', 'bright-moss', 'antique-blue', 'dark-granite', 'turquoise-sea']
createdAt	When the list was created TYPE: str
id	Unique identifier for the list TYPE: str
name	Name/title of the list TYPE: str
position	Position of the list within the board TYPE: int
type	Type/status of the list TYPE: Literal['active', 'closed', 'archive', 'trash']
updatedAt	When the list was last updated TYPE: str

boardId instance-attribute

boardId: str

ID of the board the list belongs to

color instance-attribute

color: Literal['berry-red', 'pumpkin-orange', 'lagoon-blue', 'pink-tulip', 'light-mud', 'orange-peel', 'bright-moss', 'antique-blue', 'dark-granite', 'turquoise-sea']

Color for the list

createdAt instance-attribute

createdAt: str

When the list was created

id instance-attribute

id: str

Unique identifier for the list

name instance-attribute

name: str

Name/title of the list

position instance-attribute

position: int

Position of the list within the board

type instance-attribute

type: Literal['active', 'closed', 'archive', 'trash']

Type/status of the list

updatedAt instance-attribute

updatedAt: str

When the list was last updated

Notification

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing
  •  Included_readCardNotifications  notifications
  •  Response_getNotification  item
  •  Response_getNotifications  items
  •  Response_readAllNotifications  items
  •  Response_updateNotification  item

Subclassed by:

• Plankapy v2 models Notification  Notification

ATTRIBUTE	DESCRIPTION
actionId	ID of the action associated with the notification TYPE: str
boardId	ID of the board associated with the notification (denormalized) TYPE: str
cardId	ID of the card associated with the notification TYPE: str
commentId	ID of the comment associated with the notification TYPE: str
createdAt	When the notification was created TYPE: str
creatorUserId	ID of the user who created the notification TYPE: str
data	Notification specific data (varies by type) TYPE: dict[str, Any]
id	Unique identifier for the notification TYPE: str
isRead	Whether the notification has been read TYPE: bool
type	Type of the notification TYPE: Literal['moveCard', 'commentCard', 'addMemberToCard', 'mentionInComment']
updatedAt	When the notification was last updated TYPE: str
userId	ID of the user who receives the notification TYPE: str

actionId instance-attribute

actionId: str

ID of the action associated with the notification

boardId instance-attribute

boardId: str

ID of the board associated with the notification (denormalized)

cardId instance-attribute

cardId: str

ID of the card associated with the notification

commentId instance-attribute

commentId: str

ID of the comment associated with the notification

createdAt instance-attribute

createdAt: str

When the notification was created

creatorUserId instance-attribute

creatorUserId: str

ID of the user who created the notification

data instance-attribute

data: dict[str, Any]

Notification specific data (varies by type)

id instance-attribute

id: str

Unique identifier for the notification

isRead instance-attribute

isRead: bool

Whether the notification has been read

type instance-attribute

type: Literal['moveCard', 'commentCard', 'addMemberToCard', 'mentionInComment']

Type of the notification

updatedAt instance-attribute

updatedAt: str

When the notification was last updated

userId instance-attribute

userId: str

ID of the user who receives the notification

NotificationService

Bases: TypedDict

Returned by:

• Plankapy v2
  • Planka Utilities  PlankaSnapshot  notification_services
  • api REST Typing
    •  Included_getProject  notificationServices
    •  Included_getProjects  notificationServices
    •  Included_getUser  notificationServices
    •  Response_createBoardNotificationService  item
    •  Response_createUserNotificationService  item
    •  Response_deleteNotificationService  item
    •  Response_testNotificationService  item
    •  Response_updateNotificationService  item

Subclassed by:

• Plankapy v2 models Notification Service  NotificationService

ATTRIBUTE	DESCRIPTION
boardId	ID of the board the service is associated with TYPE: str
createdAt	When the notification service was created TYPE: str
format	Format for notification messages TYPE: Literal['text', 'markdown', 'html']
id	Unique identifier for the notification service TYPE: str
updatedAt	When the notification service was last updated TYPE: str
url	URL endpoint for notifications TYPE: str
userId	ID of the user the service is associated with TYPE: str

boardId instance-attribute

boardId: str

ID of the board the service is associated with

createdAt instance-attribute

createdAt: str

When the notification service was created

format instance-attribute

format: Literal['text', 'markdown', 'html']

Format for notification messages

id instance-attribute

id: str

Unique identifier for the notification service

updatedAt instance-attribute

updatedAt: str

When the notification service was last updated

url instance-attribute

url: str

URL endpoint for notifications

userId instance-attribute

userId: str

ID of the user the service is associated with

Project

Bases: TypedDict

Returned by:

• Plankapy v2
  • Planka Utilities  PlankaSnapshot  projects
  • api REST Typing
    •  Included_getBoard  projects
    •  Response_createProject  item
    •  Response_deleteProject  item
    •  Response_updateProject  item

Subclassed by:

• Plankapy v2
  • models Project  Project
  • api REST Typing
    •  Item_getProject
    •  Items_getProjects

ATTRIBUTE	DESCRIPTION
backgroundGradient	Gradient background for the project TYPE: Literal['old-lime', 'ocean-dive', 'tzepesch-style', 'jungle-mesh', 'strawberry-dust', 'purple-rose', 'sun-scream', 'warm-rust', 'sky-change', 'green-eyes', 'blue-xchange', 'blood-orange', 'sour-peel', 'green-ninja', 'algae-green', 'coral-reef', 'steel-grey', 'heat-waves', 'velvet-lounge', 'purple-rain', 'blue-steel', 'blueish-curve', 'prism-light', 'green-mist', 'red-curtain']
backgroundImageId	ID of the background image used as background TYPE: str
backgroundType	Type of background for the project TYPE: Literal['gradient', 'image']
createdAt	When the project was created TYPE: str
description	Detailed description of the project TYPE: str
id	Unique identifier for the project TYPE: str
isHidden	Whether the project is hidden TYPE: bool
name	Name/title of the project TYPE: str
ownerProjectManagerId	ID of the project manager who owns the project TYPE: str
updatedAt	When the project was last updated TYPE: str

backgroundGradient instance-attribute

backgroundGradient: Literal['old-lime', 'ocean-dive', 'tzepesch-style', 'jungle-mesh', 'strawberry-dust', 'purple-rose', 'sun-scream', 'warm-rust', 'sky-change', 'green-eyes', 'blue-xchange', 'blood-orange', 'sour-peel', 'green-ninja', 'algae-green', 'coral-reef', 'steel-grey', 'heat-waves', 'velvet-lounge', 'purple-rain', 'blue-steel', 'blueish-curve', 'prism-light', 'green-mist', 'red-curtain']

Gradient background for the project

backgroundImageId instance-attribute

backgroundImageId: str

ID of the background image used as background

backgroundType instance-attribute

backgroundType: Literal['gradient', 'image']

Type of background for the project

createdAt instance-attribute

createdAt: str

When the project was created

description instance-attribute

description: str

Detailed description of the project

id instance-attribute

id: str

Unique identifier for the project

isHidden instance-attribute

isHidden: bool

Whether the project is hidden

name instance-attribute

name: str

Name/title of the project

ownerProjectManagerId instance-attribute

ownerProjectManagerId: str

ID of the project manager who owns the project

updatedAt instance-attribute

updatedAt: str

When the project was last updated

ProjectManager

Bases: TypedDict

Returned by:

• Plankapy v2
  • Planka Utilities  PlankaSnapshot  project_managers
  • api REST Typing
    •  Included_createProject  projectManagers
    •  Included_getProject  projectManagers
    •  Included_getProjects  projectManagers
    •  Response_createProjectManager  item
    •  Response_deleteProjectManager  item

Subclassed by:

• Plankapy v2 models Project Manager  ProjectManager

ATTRIBUTE	DESCRIPTION
createdAt	When the project manager was created TYPE: str
id	Unique identifier for the project manager TYPE: str
projectId	ID of the project the manager is associated with TYPE: str
updatedAt	When the project manager was last updated TYPE: str
userId	ID of the user who is assigned as project manager TYPE: str

createdAt instance-attribute

createdAt: str

When the project manager was created

id instance-attribute

id: str

Unique identifier for the project manager

projectId instance-attribute

projectId: str

ID of the project the manager is associated with

updatedAt instance-attribute

updatedAt: str

When the project manager was last updated

userId instance-attribute

userId: str

ID of the user who is assigned as project manager

Stopwatch

Bases: TypedDict

Returned by:

• Plankapy v2 api
  • REST Typing
    •  Card  stopwatch
    •  Included_getBoard_all  stopwatch
    •  Included_getList_all  stopwatch
    •  Item_getCard  stopwatch
    •  Items_getCards  stopwatch
    •  Request_updateCard  stopwatch
  • Schemas  Card  stopwatch

ATTRIBUTE	DESCRIPTION
startedAt	The time that a running stopwatch was started TYPE: str | None
total	The number of seconds that the stopwatch has been running TYPE: int

startedAt instance-attribute

startedAt: str | None

The time that a running stopwatch was started

total instance-attribute

total: int

The number of seconds that the stopwatch has been running

Task

Bases: TypedDict

Returned by:

• Plankapy v2
  • Planka Utilities  PlankaSnapshot  tasks
  • api REST Typing
    •  Included_duplicateCard  tasks
    •  Included_getBoard  tasks
    •  Included_getCard  tasks
    •  Included_getCards  tasks
    •  Included_getList  tasks
    •  Included_getTaskList  tasks
    •  Response_createTask  item
    •  Response_deleteTask  item
    •  Response_updateTask  item

Subclassed by:

• Plankapy v2 models Task  Task

ATTRIBUTE	DESCRIPTION
assigneeUserId	ID of the user assigned to the task TYPE: str
createdAt	When the task was created TYPE: str
id	Unique identifier for the task TYPE: str
isCompleted	Whether the task is completed TYPE: bool
linkedCardId	ID of the card linked to the task TYPE: str
name	Name/title of the task TYPE: str
position	Position of the task within the task list TYPE: int
taskListId	ID of the task list the task belongs to TYPE: str
updatedAt	When the task was last updated TYPE: str

assigneeUserId instance-attribute

assigneeUserId: str

ID of the user assigned to the task

createdAt instance-attribute

createdAt: str

When the task was created

id instance-attribute

id: str

Unique identifier for the task

isCompleted instance-attribute

isCompleted: bool

Whether the task is completed

linkedCardId instance-attribute

linkedCardId: str

ID of the card linked to the task

name instance-attribute

name: str

Name/title of the task

position instance-attribute

position: int

Position of the task within the task list

taskListId instance-attribute

taskListId: str

ID of the task list the task belongs to

updatedAt instance-attribute

updatedAt: str

When the task was last updated

TaskList

Bases: TypedDict

Returned by:

• Plankapy v2
  • Planka Utilities  PlankaSnapshot  task_lists
  • api REST Typing
    •  Included_duplicateCard  taskLists
    •  Included_getBoard  taskLists
    •  Included_getCard  taskLists
    •  Included_getCards  taskLists
    •  Included_getList  taskLists
    •  Response_createTaskList  item
    •  Response_deleteTaskList  item
    •  Response_getTaskList  item
    •  Response_updateTaskList  item

Subclassed by:

• Plankapy v2 models Task List  TaskList

ATTRIBUTE	DESCRIPTION
cardId	ID of the card the task list belongs to TYPE: str
createdAt	When the task list was created TYPE: str
hideCompletedTasks	Whether to hide completed tasks TYPE: bool
id	Unique identifier for the task list TYPE: str
name	Name/title of the task list TYPE: str
position	Position of the task list within the card TYPE: int
showOnFrontOfCard	Whether to show the task list on the front of the card TYPE: bool
updatedAt	When the task list was last updated TYPE: str

cardId instance-attribute

cardId: str

ID of the card the task list belongs to

createdAt instance-attribute

createdAt: str

When the task list was created

hideCompletedTasks instance-attribute

hideCompletedTasks: bool

Whether to hide completed tasks

id instance-attribute

id: str

Unique identifier for the task list

name instance-attribute

name: str

Name/title of the task list

position instance-attribute

position: int

Position of the task list within the card

showOnFrontOfCard instance-attribute

showOnFrontOfCard: bool

Whether to show the task list on the front of the card

updatedAt instance-attribute

updatedAt: str

When the task list was last updated

User

Bases: TypedDict

Returned by:

• Plankapy v2
  • Planka Utilities  PlankaSnapshot  users
  • api REST Typing
    •  Included_getBoard  users
    •  Included_getBoardActions  users
    •  Included_getCard  users
    •  Included_getCardActions  users
    •  Included_getCards  users
    •  Included_getComments  users
    •  Included_getList  users
    •  Included_getNotification  users
    •  Included_getNotifications  users
    •  Included_getProject  users
    •  Included_getProjects  users
    •  Response_createUser  item
    •  Response_deleteUser  item
    •  Response_getUser  item
    •  Response_getUsers  items
    •  Response_updateUser  item
    •  Response_updateUserAvatar  item
    •  Response_updateUserEmail  item
    •  Response_updateUserPassword  item
    •  Response_updateUserUsername  item

Subclassed by:

• Plankapy v2 models User  User

ATTRIBUTE	DESCRIPTION
apiKeyPrefix	The prefix for the user's API key if one is active TYPE: str | None
avatar	Avatar information for the user with generated URLs TYPE: dict[str, Any]
createdAt	When the user was created TYPE: str
defaultEditorMode	Default markdown editor mode (personal field) TYPE: NotRequired[Literal['wysiwyg', 'markup']]
defaultHomeView	Default view mode for the home page (personal field) TYPE: NotRequired[Literal['gridProjects', 'groupedProjects']]
defaultProjectsOrder	Default sort order for projects display (personal field) TYPE: NotRequired[Literal['byDefault', 'alphabetically', 'byCreationTime']]
email	Email address for login and notifications (private field) TYPE: NotRequired[str]
enableFavoritesByDefault	Whether favorites are enabled by default (personal field) TYPE: NotRequired[bool]
gravatarUrl	Gravatar URL for the user (conditionally added if configured) TYPE: NotRequired[str]
id	Unique identifier for the user TYPE: str
isDeactivated	Whether the user account is deactivated and cannot log in TYPE: bool
isDefaultAdmin	Whether the user is the default admin (visible only to current user or admin) TYPE: NotRequired[bool]
isSsoUser	Whether the user is SSO user (private field) TYPE: NotRequired[bool]
language	Preferred language for user interface and notifications (personal field) TYPE: NotRequired[Literal['ar-YE', 'bg-BG', 'cs-CZ', 'da-DK', 'de-DE', 'el-GR', 'en-GB', 'en-US', 'es-ES', 'et-EE', 'fa-IR', 'fi-FI', 'fr-FR', 'hu-HU', 'id-ID', 'it-IT', 'ja-JP', 'ko-KR', 'nl-NL', 'pl-PL', 'pt-BR', 'pt-PT', 'ro-RO', 'ru-RU', 'sk-SK', 'sr-Cyrl-RS', 'sr-Latn-RS', 'sv-SE', 'tr-TR', 'uk-UA', 'uz-UZ', 'zh-CN', 'zh-TW']]
lockedFieldNames	List of fields locked from editing (visible only to current user or admin) TYPE: NotRequired[list[Literal['email', 'password', 'name']]]
name	Full display name of the user TYPE: str
organization	Organization or company name TYPE: str
phone	Contact phone number TYPE: str
role	User role defining access permissions TYPE: Literal['admin', 'projectOwner', 'boardUser']
subscribeToCardWhenCommenting	Whether the user subscribes to cards when commenting (personal field) TYPE: NotRequired[bool]
subscribeToOwnCards	Whether the user subscribes to their own cards (personal field) TYPE: NotRequired[bool]
termsType	Type of terms applicable to the user based on role TYPE: Literal['general', 'extended']
turnOffRecentCardHighlighting	Whether recent card highlighting is disabled (personal field) TYPE: NotRequired[bool]
updatedAt	When the user was last updated TYPE: str
username	Unique username for user identification TYPE: str

apiKeyPrefix instance-attribute

apiKeyPrefix: str | None

The prefix for the user's API key if one is active

avatar instance-attribute

avatar: dict[str, Any]

Avatar information for the user with generated URLs

createdAt instance-attribute

createdAt: str

When the user was created

defaultEditorMode instance-attribute

defaultEditorMode: NotRequired[Literal['wysiwyg', 'markup']]

Default markdown editor mode (personal field)

defaultHomeView instance-attribute

defaultHomeView: NotRequired[Literal['gridProjects', 'groupedProjects']]

Default view mode for the home page (personal field)

defaultProjectsOrder instance-attribute

defaultProjectsOrder: NotRequired[Literal['byDefault', 'alphabetically', 'byCreationTime']]

Default sort order for projects display (personal field)

email instance-attribute

email: NotRequired[str]

Email address for login and notifications (private field)

enableFavoritesByDefault instance-attribute

enableFavoritesByDefault: NotRequired[bool]

Whether favorites are enabled by default (personal field)

gravatarUrl instance-attribute

gravatarUrl: NotRequired[str]

Gravatar URL for the user (conditionally added if configured)

id instance-attribute

id: str

Unique identifier for the user

isDeactivated instance-attribute

isDeactivated: bool

Whether the user account is deactivated and cannot log in

isDefaultAdmin instance-attribute

isDefaultAdmin: NotRequired[bool]

Whether the user is the default admin (visible only to current user or admin)

isSsoUser instance-attribute

isSsoUser: NotRequired[bool]

Whether the user is SSO user (private field)

language instance-attribute

language: NotRequired[Literal['ar-YE', 'bg-BG', 'cs-CZ', 'da-DK', 'de-DE', 'el-GR', 'en-GB', 'en-US', 'es-ES', 'et-EE', 'fa-IR', 'fi-FI', 'fr-FR', 'hu-HU', 'id-ID', 'it-IT', 'ja-JP', 'ko-KR', 'nl-NL', 'pl-PL', 'pt-BR', 'pt-PT', 'ro-RO', 'ru-RU', 'sk-SK', 'sr-Cyrl-RS', 'sr-Latn-RS', 'sv-SE', 'tr-TR', 'uk-UA', 'uz-UZ', 'zh-CN', 'zh-TW']]

Preferred language for user interface and notifications (personal field)

lockedFieldNames instance-attribute

lockedFieldNames: NotRequired[list[Literal['email', 'password', 'name']]]

List of fields locked from editing (visible only to current user or admin)

name instance-attribute

name: str

Full display name of the user

organization instance-attribute

organization: str

Organization or company name

phone instance-attribute

phone: str

Contact phone number

role instance-attribute

role: Literal['admin', 'projectOwner', 'boardUser']

User role defining access permissions

subscribeToCardWhenCommenting instance-attribute

subscribeToCardWhenCommenting: NotRequired[bool]

Whether the user subscribes to cards when commenting (personal field)

subscribeToOwnCards instance-attribute

subscribeToOwnCards: NotRequired[bool]

Whether the user subscribes to their own cards (personal field)

termsType instance-attribute

termsType: Literal['general', 'extended']

Type of terms applicable to the user based on role

turnOffRecentCardHighlighting instance-attribute

turnOffRecentCardHighlighting: NotRequired[bool]

Whether recent card highlighting is disabled (personal field)

updatedAt instance-attribute

updatedAt: str

When the user was last updated

username instance-attribute

username: str

Unique username for user identification

Webhook

Bases: TypedDict

Returned by:

• Plankapy v2
  • Planka Utilities  PlankaSnapshot  webhooks
  • api REST Typing
    •  Response_createWebhook  item
    •  Response_deleteWebhook  item
    •  Response_getWebhooks  items
    •  Response_updateWebhook  item

Subclassed by:

• Plankapy v2 models Webhook  Webhook

ATTRIBUTE	DESCRIPTION
accessToken	Access token for webhook authentication TYPE: str
boardId	The board that the webhook is associated with TYPE: str
createdAt	When the webhook was created TYPE: str
events	List of events that trigger the webhook TYPE: list[WebhookEvent]
excludedEvents	List of events excluded from the webhook TYPE: list[WebhookEvent]
id	Unique identifier for the webhook TYPE: str
name	Name/title of the webhook TYPE: str
updatedAt	When the webhook was last updated TYPE: str
url	URL endpoint for the webhook TYPE: str

accessToken instance-attribute

accessToken: str

Access token for webhook authentication

boardId instance-attribute

boardId: str

The board that the webhook is associated with

createdAt instance-attribute

createdAt: str

When the webhook was created

events instance-attribute

events: list[WebhookEvent]

List of events that trigger the webhook

excludedEvents instance-attribute

excludedEvents: list[WebhookEvent]

List of events excluded from the webhook

id instance-attribute

id: str

Unique identifier for the webhook

name instance-attribute

name: str

Name/title of the webhook

updatedAt instance-attribute

updatedAt: str

When the webhook was last updated

url instance-attribute

url: str

URL endpoint for the webhook