REST Typing

All Planka API endpoints habe their request/response body typed here using TypedDict. This means that at runtime all objects here are dict objects, but can be statically analyzed by a type checker.

CLASS	DESCRIPTION
Action
Attachment
BackgroundImage
BaseCustomFieldGroup
Board
BoardMembership
Card
CardLabel
CardMembership
Comment
Config
CustomField
CustomFieldGroup
CustomFieldValue
Included_createBoard
Included_createProject
Included_deleteList
Included_duplicateCard
Included_getBoard
Included_getBoardActions
Included_getBoard_all
Included_getCard
Included_getCardActions
Included_getCards
Included_getComments
Included_getCustomFieldGroup
Included_getList
Included_getList_all
Included_getNotification
Included_getNotifications
Included_getProject
Included_getProjects
Included_getTaskList
Included_getUser
Included_moveListCards
Included_readCardNotifications
Included_sortList
Included_updateUserPassword
Item_getBoard
Item_getCard
Item_getProject
Item_getTerms
Items_getCards
Items_getProjects
Label
List
Notification
NotificationService
Project
ProjectManager
Request_acceptTerms
Request_createAccessToken
Request_createAttachment
Request_createBackgroundImage
Request_createBaseCustomFieldGroup
Request_createBoard
Request_createBoardCustomFieldGroup
Request_createBoardMembership
Request_createBoardNotificationService
Request_createCard
Request_createCardCustomFieldGroup
Request_createCardLabel
Request_createCardMembership
Request_createComment
Request_createCustomFieldInBaseGroup
Request_createCustomFieldInGroup
Request_createLabel
Request_createList
Request_createProject
Request_createProjectManager
Request_createTask
Request_createTaskList
Request_createUser
Request_createUserNotificationService
Request_createWebhook
Request_duplicateCard
Request_exchangeForAccessTokenWithOidc
Request_getBoard
Request_getBoardActions
Request_getCardActions
Request_getCards
Request_getComments
Request_getTerms
Request_getUser
Request_moveListCards
Request_revokePendingToken
Request_sortList
Request_updateAttachment
Request_updateBaseCustomFieldGroup
Request_updateBoard
Request_updateBoardMembership
Request_updateCard
Request_updateComments
Request_updateCustomField
Request_updateCustomFieldGroup
Request_updateCustomFieldValue
Request_updateLabel
Request_updateList
Request_updateNotification
Request_updateNotificationService
Request_updateProject
Request_updateTask
Request_updateTaskList
Request_updateUser
Request_updateUserAvatar
Request_updateUserEmail
Request_updateUserPassword
Request_updateUserUsername
Request_updateWebhook
Response_acceptTerms	Terms accepted successfully
Response_clearList	List cleared successfully
Response_createAccessToken	Login successful
Response_createAttachment	Attachment created successfully
Response_createBackgroundImage	Background image uploaded successfully
Response_createBaseCustomFieldGroup	Base custom field group created successfully
Response_createBoard	Board created successfully
Response_createBoardCustomFieldGroup	Custom field group created successfully
Response_createBoardMembership	Board membership created successfully
Response_createBoardNotificationService	Notification service created successfully
Response_createCard	Card created successfully
Response_createCardCustomFieldGroup	Custom field group created successfully
Response_createCardLabel	Label added to card successfully
Response_createCardMembership	User added to card successfully
Response_createComment	Comment created successfully
Response_createCustomFieldInBaseGroup	Custom field created successfully
Response_createCustomFieldInGroup	Custom field created successfully
Response_createLabel	Label created successfully
Response_createList	List created successfully
Response_createProject	Project created successfully
Response_createProjectManager	Project manager created successfully
Response_createTask	Task created successfully
Response_createTaskList	Task list created successfully
Response_createUser	User created successfully
Response_createUserNotificationService	Notification service created successfully
Response_createWebhook	Webhook created successfully
Response_deleteAccessToken	Logout successful
Response_deleteAttachment	Attachment deleted successfully
Response_deleteBackgroundImage	Background image deleted successfully
Response_deleteBaseCustomFieldGroup	Base custom field group deleted successfully
Response_deleteBoard	Board deleted successfully
Response_deleteBoardMembership	Board membership deleted successfully
Response_deleteCard	Card deleted successfully
Response_deleteCardLabel	Label removed from card successfully
Response_deleteCardMembership	User removed from card successfully
Response_deleteComment	Comment deleted successfully
Response_deleteCustomField	Custom field deleted successfully
Response_deleteCustomFieldGroup	Custom field group deleted successfully
Response_deleteCustomFieldValue	Custom field value deleted successfully
Response_deleteLabel	Label deleted successfully
Response_deleteList	List deleted successfully
Response_deleteNotificationService	Notification service deleted successfully
Response_deleteProject	Project deleted successfully
Response_deleteProjectManager	Project manager deleted successfully
Response_deleteTask	Task deleted successfully
Response_deleteTaskList	Task list deleted successfully
Response_deleteUser	User deleted successfully
Response_deleteWebhook	Webhook deleted successfully
Response_duplicateCard	Card duplicated successfully
Response_exchangeForAccessTokenWithOidc	OIDC exchange successful
Response_getBoard	Board details retrieved successfully
Response_getBoardActions	Board actions retrieved successfully
Response_getCard	Card details retrieved successfully
Response_getCardActions	Card actions retrieved successfully
Response_getCards	Cards retrieved successfully
Response_getComments	Comments retrieved successfully
Response_getConfig	Configuration retrieved successfully
Response_getCustomFieldGroup	Custom field group details retrieved successfully
Response_getList	List details retrieved successfully
Response_getNotification	Notification details retrieved successfully
Response_getNotifications	Notifications retrieved successfully
Response_getProject	Project details retrieved successfully
Response_getProjects	Projects retrieved successfully
Response_getTaskList	Task list details retrieved successfully
Response_getTerms	Terms content retrieved successfully
Response_getUser	User details retrieved successfully
Response_getUsers	List of users retrieved successfully
Response_getWebhooks	List of webhooks retrieved successfully
Response_moveListCards	Cards moved successfully
Response_readAllNotifications	Notifications marked as read successfully
Response_readCardNotifications	Notifications marked as read successfully
Response_revokePendingToken	Pending token revoked successfully
Response_sortList	List sorted successfully
Response_testNotificationService	Test notification sent successfully
Response_updateAttachment	Attachment updated successfully
Response_updateBaseCustomFieldGroup	Base custom field group updated successfully
Response_updateBoard	Board updated successfully
Response_updateBoardMembership	Board membership updated successfully
Response_updateCard	Card updated successfully
Response_updateComments	Comment updated successfully
Response_updateCustomField	Custom field updated successfully
Response_updateCustomFieldGroup	Custom field group updated successfully
Response_updateCustomFieldValue	Custom field value created or updated successfully
Response_updateLabel	Label updated successfully
Response_updateList	List updated successfully
Response_updateNotification	Notification updated successfully
Response_updateNotificationService	Notification service updated successfully
Response_updateProject	Project updated successfully
Response_updateTask	Task updated successfully
Response_updateTaskList	Task list updated successfully
Response_updateUser	User updated successfully
Response_updateUserAvatar	Avatar updated successfully
Response_updateUserEmail	Email updated successfully
Response_updateUserPassword	Password updated successfully
Response_updateUserUsername	Username updated successfully
Response_updateWebhook	Webhook updated successfully
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

Included_createBoard

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_createBoard  included

ATTRIBUTE	DESCRIPTION
boardMemberships	TYPE: list[BoardMembership]

boardMemberships instance-attribute

boardMemberships: list[BoardMembership]

Included_createProject

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_createProject  included

ATTRIBUTE	DESCRIPTION
projectManagers	TYPE: list[ProjectManager]

projectManagers instance-attribute

projectManagers: list[ProjectManager]

Included_deleteList

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_deleteList  included

ATTRIBUTE	DESCRIPTION
cards	TYPE: list[Card]

cards instance-attribute

cards: list[Card]

Included_duplicateCard

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_duplicateCard  included

ATTRIBUTE	DESCRIPTION
attachments	TYPE: list[Attachment]
cardLabels	TYPE: list[CardLabel]
cardMemberships	TYPE: list[CardMembership]
customFieldGroups	TYPE: list[CustomFieldGroup]
customFieldValues	TYPE: list[CustomFieldValue]
customFields	TYPE: list[CustomField]
taskLists	TYPE: list[TaskList]
tasks	TYPE: list[Task]

attachments instance-attribute

attachments: list[Attachment]

cardLabels instance-attribute

cardLabels: list[CardLabel]

cardMemberships instance-attribute

cardMemberships: list[CardMembership]

customFieldGroups instance-attribute

customFieldGroups: list[CustomFieldGroup]

customFieldValues instance-attribute

customFieldValues: list[CustomFieldValue]

customFields instance-attribute

customFields: list[CustomField]

taskLists instance-attribute

taskLists: list[TaskList]

tasks instance-attribute

tasks: list[Task]

Included_getBoard

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_getBoard  included

ATTRIBUTE	DESCRIPTION
attachments	TYPE: list[Attachment]
boardMemberships	TYPE: list[BoardMembership]
cardLabels	TYPE: list[CardLabel]
cardMemberships	TYPE: list[CardMembership]
cards	Related cards TYPE: list[Included_getBoard_all]
customFieldGroups	TYPE: list[CustomFieldGroup]
customFieldValues	TYPE: list[CustomFieldValue]
customFields	TYPE: list[CustomField]
labels	TYPE: list[Label]
lists	TYPE: list[List]
projects	TYPE: list[Project]
taskLists	TYPE: list[TaskList]
tasks	TYPE: list[Task]
users	TYPE: list[User]

attachments instance-attribute

attachments: list[Attachment]

boardMemberships instance-attribute

boardMemberships: list[BoardMembership]

cardLabels instance-attribute

cardLabels: list[CardLabel]

cardMemberships instance-attribute

cardMemberships: list[CardMembership]

cards instance-attribute

cards: list[Included_getBoard_all]

Related cards

customFieldGroups instance-attribute

customFieldGroups: list[CustomFieldGroup]

customFieldValues instance-attribute

customFieldValues: list[CustomFieldValue]

customFields instance-attribute

customFields: list[CustomField]

labels instance-attribute

labels: list[Label]

lists instance-attribute

lists: list[List]

projects instance-attribute

projects: list[Project]

taskLists instance-attribute

taskLists: list[TaskList]

tasks instance-attribute

tasks: list[Task]

users instance-attribute

users: list[User]

Included_getBoardActions

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_getBoardActions  included

ATTRIBUTE	DESCRIPTION
users	TYPE: list[User]

users instance-attribute

users: list[User]

Included_getBoard_all

Bases: Card

Returned by:

• Plankapy v2 api REST Typing  Included_getBoard  cards

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
isSubscribed	Whether the current user is subscribed to the card 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

isSubscribed instance-attribute

isSubscribed: bool

Whether the current user is subscribed to the card

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

Included_getCard

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_getCard  included

ATTRIBUTE	DESCRIPTION
attachments	TYPE: list[Attachment]
cardLabels	TYPE: list[CardLabel]
cardMemberships	TYPE: list[CardMembership]
customFieldGroups	TYPE: list[CustomFieldGroup]
customFieldValues	TYPE: list[CustomFieldValue]
customFields	TYPE: list[CustomField]
taskLists	TYPE: list[TaskList]
tasks	TYPE: list[Task]
users	TYPE: list[User]

attachments instance-attribute

attachments: list[Attachment]

cardLabels instance-attribute

cardLabels: list[CardLabel]

cardMemberships instance-attribute

cardMemberships: list[CardMembership]

customFieldGroups instance-attribute

customFieldGroups: list[CustomFieldGroup]

customFieldValues instance-attribute

customFieldValues: list[CustomFieldValue]

customFields instance-attribute

customFields: list[CustomField]

taskLists instance-attribute

taskLists: list[TaskList]

tasks instance-attribute

tasks: list[Task]

users instance-attribute

users: list[User]

Included_getCardActions

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_getCardActions  included

ATTRIBUTE	DESCRIPTION
users	TYPE: list[User]

users instance-attribute

users: list[User]

Included_getCards

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_getCards  included

ATTRIBUTE	DESCRIPTION
attachments	TYPE: list[Attachment]
cardLabels	TYPE: list[CardLabel]
cardMemberships	TYPE: list[CardMembership]
customFieldGroups	TYPE: list[CustomFieldGroup]
customFieldValues	TYPE: list[CustomFieldValue]
customFields	TYPE: list[CustomField]
taskLists	TYPE: list[TaskList]
tasks	TYPE: list[Task]
users	TYPE: list[User]

attachments instance-attribute

attachments: list[Attachment]

cardLabels instance-attribute

cardLabels: list[CardLabel]

cardMemberships instance-attribute

cardMemberships: list[CardMembership]

customFieldGroups instance-attribute

customFieldGroups: list[CustomFieldGroup]

customFieldValues instance-attribute

customFieldValues: list[CustomFieldValue]

customFields instance-attribute

customFields: list[CustomField]

taskLists instance-attribute

taskLists: list[TaskList]

tasks instance-attribute

tasks: list[Task]

users instance-attribute

users: list[User]

Included_getComments

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_getComments  included

ATTRIBUTE	DESCRIPTION
users	TYPE: list[User]

users instance-attribute

users: list[User]

Included_getCustomFieldGroup

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_getCustomFieldGroup  included

ATTRIBUTE	DESCRIPTION
customFieldValues	TYPE: list[CustomFieldValue]
customFields	TYPE: list[CustomField]

customFieldValues instance-attribute

customFieldValues: list[CustomFieldValue]

customFields instance-attribute

customFields: list[CustomField]

Included_getList

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_getList  included

ATTRIBUTE	DESCRIPTION
attachments	TYPE: list[Attachment]
cardLabels	TYPE: list[CardLabel]
cardMemberships	TYPE: list[CardMembership]
cards	Related cards TYPE: list[Included_getList_all]
customFieldGroups	TYPE: list[CustomFieldGroup]
customFieldValues	TYPE: list[CustomFieldValue]
customFields	TYPE: list[CustomField]
taskLists	TYPE: list[TaskList]
tasks	TYPE: list[Task]
users	TYPE: list[User]

attachments instance-attribute

attachments: list[Attachment]

cardLabels instance-attribute

cardLabels: list[CardLabel]

cardMemberships instance-attribute

cardMemberships: list[CardMembership]

cards instance-attribute

cards: list[Included_getList_all]

Related cards

customFieldGroups instance-attribute

customFieldGroups: list[CustomFieldGroup]

customFieldValues instance-attribute

customFieldValues: list[CustomFieldValue]

customFields instance-attribute

customFields: list[CustomField]

taskLists instance-attribute

taskLists: list[TaskList]

tasks instance-attribute

tasks: list[Task]

users instance-attribute

users: list[User]

Included_getList_all

Bases: Card

Returned by:

• Plankapy v2 api REST Typing  Included_getList  cards

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
isSubscribed	Whether the current user is subscribed to the card 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

isSubscribed instance-attribute

isSubscribed: bool

Whether the current user is subscribed to the card

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

Included_getNotification

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_getNotification  included

ATTRIBUTE	DESCRIPTION
users	TYPE: list[User]

users instance-attribute

users: list[User]

Included_getNotifications

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_getNotifications  included

ATTRIBUTE	DESCRIPTION
users	TYPE: list[User]

users instance-attribute

users: list[User]

Included_getProject

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_getProject  included

ATTRIBUTE	DESCRIPTION
backgroundImages	TYPE: list[BackgroundImage]
baseCustomFieldGroups	TYPE: list[BaseCustomFieldGroup]
boardMemberships	TYPE: list[BoardMembership]
boards	TYPE: list[Board]
customFields	TYPE: list[CustomField]
notificationServices	TYPE: list[NotificationService]
projectManagers	TYPE: list[ProjectManager]
users	TYPE: list[User]

backgroundImages instance-attribute

backgroundImages: list[BackgroundImage]

baseCustomFieldGroups instance-attribute

baseCustomFieldGroups: list[BaseCustomFieldGroup]

boardMemberships instance-attribute

boardMemberships: list[BoardMembership]

boards instance-attribute

boards: list[Board]

customFields instance-attribute

customFields: list[CustomField]

notificationServices instance-attribute

notificationServices: list[NotificationService]

projectManagers instance-attribute

projectManagers: list[ProjectManager]

users instance-attribute

users: list[User]

Included_getProjects

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_getProjects  included

ATTRIBUTE	DESCRIPTION
backgroundImages	TYPE: list[BackgroundImage]
baseCustomFieldGroups	TYPE: list[BaseCustomFieldGroup]
boardMemberships	TYPE: list[BoardMembership]
boards	TYPE: list[Board]
customFields	TYPE: list[CustomField]
notificationServices	TYPE: list[NotificationService]
projectManagers	TYPE: list[ProjectManager]
users	TYPE: list[User]

backgroundImages instance-attribute

backgroundImages: list[BackgroundImage]

baseCustomFieldGroups instance-attribute

baseCustomFieldGroups: list[BaseCustomFieldGroup]

boardMemberships instance-attribute

boardMemberships: list[BoardMembership]

boards instance-attribute

boards: list[Board]

customFields instance-attribute

customFields: list[CustomField]

notificationServices instance-attribute

notificationServices: list[NotificationService]

projectManagers instance-attribute

projectManagers: list[ProjectManager]

users instance-attribute

users: list[User]

Included_getTaskList

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_getTaskList  included

ATTRIBUTE	DESCRIPTION
tasks	TYPE: list[Task]

tasks instance-attribute

tasks: list[Task]

Included_getUser

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_getUser  included

ATTRIBUTE	DESCRIPTION
notificationServices	TYPE: list[NotificationService]

notificationServices instance-attribute

notificationServices: list[NotificationService]

Included_moveListCards

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_moveListCards  included

ATTRIBUTE	DESCRIPTION
actions	TYPE: list[Action]
cards	TYPE: list[Card]

actions instance-attribute

actions: list[Action]

cards instance-attribute

cards: list[Card]

Included_readCardNotifications

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_readCardNotifications  included

ATTRIBUTE	DESCRIPTION
notifications	TYPE: list[Notification]

notifications instance-attribute

notifications: list[Notification]

Included_sortList

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_sortList  included

ATTRIBUTE	DESCRIPTION
cards	TYPE: list[Card]

cards instance-attribute

cards: list[Card]

Included_updateUserPassword

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_updateUserPassword  included

ATTRIBUTE	DESCRIPTION
accessTokens	New acces tokens (when updating own password) TYPE: list[str]

accessTokens instance-attribute

accessTokens: list[str]

New acces tokens (when updating own password)

Item_getBoard

Bases: Board

Returned by:

• Plankapy v2 api REST Typing  Response_getBoard  item

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
isSubscribed	Whether the current user is subscribed to the board TYPE: bool
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

isSubscribed instance-attribute

isSubscribed: bool

Whether the current user is subscribed to 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

Item_getCard

Bases: Card

Returned by:

• Plankapy v2 api REST Typing  Response_getCard  item

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
isSubscribed	Whether the current user is subscribed to the card 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

isSubscribed instance-attribute

isSubscribed: bool

Whether the current user is subscribed to the card

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

Item_getProject

Bases: Project

Returned by:

• Plankapy v2 api REST Typing  Response_getProject  item

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
isFavorite	Whether the project is marked as favorite by the current user TYPE: bool
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

isFavorite instance-attribute

isFavorite: bool

Whether the project is marked as favorite by the current user

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

Item_getTerms

Bases: TypedDict

Returned by:

• Plankapy v2 api REST Typing  Response_getTerms  item

ATTRIBUTE	DESCRIPTION
content	TYPE: str
language	TYPE: Literal['de-DE', 'en-US']
signature	TYPE: str
type	TYPE: Literal['general', 'extended']

content instance-attribute

content: str

language instance-attribute

language: Literal['de-DE', 'en-US']

signature instance-attribute

signature: str

type instance-attribute

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

Items_getCards

Bases: Card

Returned by:

• Plankapy v2 api REST Typing  Response_getCards  items

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
isSubscribed	Whether the current user is subscribed to the card 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

isSubscribed instance-attribute

isSubscribed: bool

Whether the current user is subscribed to the card

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

Items_getProjects

Bases: Project

Returned by:

• Plankapy v2 api REST Typing  Response_getProjects  items

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
isFavorite	Whether the project is marked as favorite by the current user TYPE: bool
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

isFavorite instance-attribute

isFavorite: bool

Whether the project is marked as favorite by the current user

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

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

Request_acceptTerms

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  acceptTerms

ATTRIBUTE	DESCRIPTION
pendingToken	Pending token received from the authentication flow TYPE: str
signature	Terms signature hash based on user role TYPE: str

pendingToken instance-attribute

pendingToken: str

Pending token received from the authentication flow

signature instance-attribute

signature: str

Terms signature hash based on user role

Request_createAccessToken

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createAccessToken

ATTRIBUTE	DESCRIPTION
emailOrUsername	Email address or username of the user TYPE: str
password	Password of the user TYPE: str
withHttpOnlyToken	Whether to include an HTTP-only authentication cookie TYPE: NotRequired[bool]

emailOrUsername instance-attribute

emailOrUsername: str

Email address or username of the user

password instance-attribute

password: str

Password of the user

withHttpOnlyToken instance-attribute

withHttpOnlyToken: NotRequired[bool]

Whether to include an HTTP-only authentication cookie

Request_createAttachment

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createAttachment

ATTRIBUTE	DESCRIPTION
file	File to upload TYPE: NotRequired[str | bytes]
name	Name/title of the attachment TYPE: str
requestId	Request ID for tracking TYPE: NotRequired[str]
type	Type of the attachment TYPE: Literal['file', 'link']
url	URL for the link attachment TYPE: NotRequired[str]

file instance-attribute

file: NotRequired[str | bytes]

File to upload

name instance-attribute

name: str

Name/title of the attachment

requestId instance-attribute

requestId: NotRequired[str]

Request ID for tracking

type instance-attribute

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

Type of the attachment

url instance-attribute

url: NotRequired[str]

URL for the link attachment

Request_createBackgroundImage

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createBackgroundImage

ATTRIBUTE	DESCRIPTION
file	Background image file (must be an image format) TYPE: bytes
requestId	Request ID for tracking TYPE: NotRequired[str]

file instance-attribute

file: bytes

Background image file (must be an image format)

requestId instance-attribute

requestId: NotRequired[str]

Request ID for tracking

Request_createBaseCustomFieldGroup

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createBaseCustomFieldGroup

ATTRIBUTE	DESCRIPTION
name	Name/title of the base custom field group TYPE: str

name instance-attribute

name: str

Name/title of the base custom field group

Request_createBoard

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createBoard

ATTRIBUTE	DESCRIPTION
importFile	Import file TYPE: NotRequired[bytes]
importType	Type of import TYPE: NotRequired[Literal['trello']]
name	Name/title of the board TYPE: str
position	Position of the board within the project TYPE: int
requestId	Request ID for tracking TYPE: NotRequired[str]

importFile instance-attribute

importFile: NotRequired[bytes]

Import file

importType instance-attribute

importType: NotRequired[Literal['trello']]

Type of import

name instance-attribute

name: str

Name/title of the board

position instance-attribute

position: int

Position of the board within the project

requestId instance-attribute

requestId: NotRequired[str]

Request ID for tracking

Request_createBoardCustomFieldGroup

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createBoardCustomFieldGroup

ATTRIBUTE	DESCRIPTION
baseCustomFieldGroupId	ID of the base custom field group used as a template TYPE: NotRequired[str]
name	Name/title of the custom field group (required if baseCustomFieldGroupId is not provided) TYPE: NotRequired[str | None]
position	Position of the custom field group within the board TYPE: int

baseCustomFieldGroupId instance-attribute

baseCustomFieldGroupId: NotRequired[str]

ID of the base custom field group used as a template

name instance-attribute

name: NotRequired[str | None]

Name/title of the custom field group (required if baseCustomFieldGroupId is not provided)

position instance-attribute

position: int

Position of the custom field group within the board

Request_createBoardMembership

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createBoardMembership

ATTRIBUTE	DESCRIPTION
canComment	Whether the user can comment on cards (applies only to viewers) TYPE: NotRequired[bool | None]
role	Role of the user in the board TYPE: Literal['editor', 'viewer']
userId	ID of the user who is a member of the board TYPE: str

canComment instance-attribute

canComment: NotRequired[bool | None]

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

role instance-attribute

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

Role of the user in the board

userId instance-attribute

userId: str

ID of the user who is a member of the board

Request_createBoardNotificationService

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createBoardNotificationService

ATTRIBUTE	DESCRIPTION
format	Format for notification messages TYPE: Literal['text', 'markdown', 'html']
url	URL endpoint for notifications TYPE: str

format instance-attribute

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

Format for notification messages

url instance-attribute

url: str

URL endpoint for notifications

Request_createCard

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createCard

ATTRIBUTE	DESCRIPTION
description	Detailed description of the card TYPE: NotRequired[str | None]
dueDate	Due date for the card (datetime only allowed when using Card.create_card, otherwise use ISO string) TYPE: NotRequired[str | datetime]
isDueCompleted	Whether the due date is completed TYPE: NotRequired[bool | None]
name	Name/title of the card TYPE: str
position	Position of the card within the list TYPE: NotRequired[int | None]
stopwatch	Stopwatch data for time tracking TYPE: NotRequired[dict[str, Any] | None]
type	Type of the card TYPE: Literal['project', 'story']

description instance-attribute

description: NotRequired[str | None]

Detailed description of the card

dueDate instance-attribute

dueDate: NotRequired[str | datetime]

Due date for the card (datetime only allowed when using Card.create_card, otherwise use ISO string)

isDueCompleted instance-attribute

isDueCompleted: NotRequired[bool | None]

Whether the due date is completed

name instance-attribute

name: str

Name/title of the card

position instance-attribute

position: NotRequired[int | None]

Position of the card within the list

stopwatch instance-attribute

stopwatch: NotRequired[dict[str, Any] | None]

Stopwatch data for time tracking

type instance-attribute

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

Type of the card

Request_createCardCustomFieldGroup

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createCardCustomFieldGroup

ATTRIBUTE	DESCRIPTION
baseCustomFieldGroupId	ID of the base custom field group used as a template TYPE: NotRequired[str]
name	Name/title of the custom field group (required if baseCustomFieldGroupId is not provided) TYPE: NotRequired[str | None]
position	Position of the custom field group within the card TYPE: int

baseCustomFieldGroupId instance-attribute

baseCustomFieldGroupId: NotRequired[str]

ID of the base custom field group used as a template

name instance-attribute

name: NotRequired[str | None]

Name/title of the custom field group (required if baseCustomFieldGroupId is not provided)

position instance-attribute

position: int

Position of the custom field group within the card

Request_createCardLabel

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createCardLabel

ATTRIBUTE	DESCRIPTION
labelId	ID of the label to add to the card TYPE: str

labelId instance-attribute

labelId: str

ID of the label to add to the card

Request_createCardMembership

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createCardMembership

ATTRIBUTE	DESCRIPTION
userId	ID of the card to add the user to TYPE: str

userId instance-attribute

userId: str

ID of the card to add the user to

Request_createComment

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createComment

ATTRIBUTE	DESCRIPTION
text	Content of the comment TYPE: str

text instance-attribute

text: str

Content of the comment

Request_createCustomFieldInBaseGroup

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createCustomFieldInBaseGroup

ATTRIBUTE	DESCRIPTION
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: NotRequired[bool]

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: NotRequired[bool]

Whether to show the field on the front of cards

Request_createCustomFieldInGroup

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createCustomFieldInGroup

ATTRIBUTE	DESCRIPTION
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: NotRequired[bool]

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: NotRequired[bool]

Whether to show the field on the front of cards

Request_createLabel

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createLabel

ATTRIBUTE	DESCRIPTION
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']
name	Name/title of the label TYPE: NotRequired[str | None]
position	Position of the label within the board TYPE: int

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

name instance-attribute

name: NotRequired[str | None]

Name/title of the label

position instance-attribute

position: int

Position of the label within the board

Request_createList

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createList

ATTRIBUTE	DESCRIPTION
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']

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']

Type/status of the list

Request_createProject

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createProject

ATTRIBUTE	DESCRIPTION
description	Detailed description of the project TYPE: NotRequired[str | None]
name	Name/title of the project TYPE: str
type	Type of the project TYPE: Literal['shared', 'private']

description instance-attribute

description: NotRequired[str | None]

Detailed description of the project

name instance-attribute

name: str

Name/title of the project

type instance-attribute

type: Literal['shared', 'private']

Type of the project

Request_createProjectManager

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createProjectManager

ATTRIBUTE	DESCRIPTION
userId	ID of the user who is assigned as project manager TYPE: str

userId instance-attribute

userId: str

ID of the user who is assigned as project manager

Request_createTask

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createTask

ATTRIBUTE	DESCRIPTION
isCompleted	Whether the task is completed TYPE: NotRequired[bool]
linkedCardId	ID of the card linked to the task TYPE: NotRequired[str]
name	Name/title of the task (required if linkedCardId is not provided) TYPE: NotRequired[str | None]
position	Position of the task within the task list TYPE: int

isCompleted instance-attribute

isCompleted: NotRequired[bool]

Whether the task is completed

linkedCardId instance-attribute

linkedCardId: NotRequired[str]

ID of the card linked to the task

name instance-attribute

name: NotRequired[str | None]

Name/title of the task (required if linkedCardId is not provided)

position instance-attribute

position: int

Position of the task within the task list

Request_createTaskList

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createTaskList

ATTRIBUTE	DESCRIPTION
hideCompletedTasks	Whether to hide completed tasks TYPE: NotRequired[bool]
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: NotRequired[bool]

hideCompletedTasks instance-attribute

hideCompletedTasks: NotRequired[bool]

Whether to hide completed tasks

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: NotRequired[bool]

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

Request_createUser

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createUser

ATTRIBUTE	DESCRIPTION
email	Email address for login and notifications TYPE: str
language	Preferred language for user interface and notifications 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'] | None]
name	Full display name of the user TYPE: str
organization	Organization or company name TYPE: NotRequired[str | None]
password	Password for user authentication (must meet password requirements) TYPE: str
phone	Contact phone number TYPE: NotRequired[str | None]
role	User role defining access permissions TYPE: Literal['admin', 'projectOwner', 'boardUser']
subscribeToCardWhenCommenting	Whether the user subscribes to cards when commenting TYPE: NotRequired[bool]
subscribeToOwnCards	Whether the user subscribes to their own cards TYPE: NotRequired[bool]
turnOffRecentCardHighlighting	Whether recent card highlighting is disabled TYPE: NotRequired[bool]
username	Unique username for user identification TYPE: NotRequired[str | None]

email instance-attribute

email: str

Email address for login and notifications

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'] | None]

Preferred language for user interface and notifications

name instance-attribute

name: str

Full display name of the user

organization instance-attribute

organization: NotRequired[str | None]

Organization or company name

password instance-attribute

password: str

Password for user authentication (must meet password requirements)

phone instance-attribute

phone: NotRequired[str | None]

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

subscribeToOwnCards instance-attribute

subscribeToOwnCards: NotRequired[bool]

Whether the user subscribes to their own cards

turnOffRecentCardHighlighting instance-attribute

turnOffRecentCardHighlighting: NotRequired[bool]

Whether recent card highlighting is disabled

username instance-attribute

username: NotRequired[str | None]

Unique username for user identification

Request_createUserNotificationService

Bases: TypedDict

Used by:

• Plankapy v2
  • api Paths/Endpoints  PlankaEndpoints  createUserNotificationService
  • models User  User  create_notification_service

ATTRIBUTE	DESCRIPTION
format	Format for notification messages TYPE: Literal['text', 'markdown', 'html']
url	URL endpoint for notifications TYPE: str

format instance-attribute

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

Format for notification messages

url instance-attribute

url: str

URL endpoint for notifications

Request_createWebhook

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createWebhook

ATTRIBUTE	DESCRIPTION
accessToken	Access token for webhook authentication TYPE: NotRequired[str | None]
events	Comma-separated list of events that trigger the webhook TYPE: NotRequired[str | None]
excludedEvents	Comma-separated list of events excluded from the webhook TYPE: NotRequired[str | None]
name	Name/title of the webhook TYPE: str
url	URL endpoint for the webhook TYPE: str

accessToken instance-attribute

accessToken: NotRequired[str | None]

Access token for webhook authentication

events instance-attribute

events: NotRequired[str | None]

Comma-separated list of events that trigger the webhook

excludedEvents instance-attribute

excludedEvents: NotRequired[str | None]

Comma-separated list of events excluded from the webhook

name instance-attribute

name: str

Name/title of the webhook

url instance-attribute

url: str

URL endpoint for the webhook

Request_duplicateCard

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  duplicateCard

ATTRIBUTE	DESCRIPTION
name	Name/title for the duplicated card TYPE: str
position	Position for the duplicated card within the list TYPE: int

name instance-attribute

name: str

Name/title for the duplicated card

position instance-attribute

position: int

Position for the duplicated card within the list

Request_exchangeForAccessTokenWithOidc

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  exchangeForAccessTokenWithOidc

ATTRIBUTE	DESCRIPTION
code	Authorization code from OIDC provider TYPE: str
nonce	Nonce value for OIDC security TYPE: str
withHttpOnlyToken	Whether to include HTTP-only authentication cookie TYPE: NotRequired[bool]

code instance-attribute

code: str

Authorization code from OIDC provider

nonce instance-attribute

nonce: str

Nonce value for OIDC security

withHttpOnlyToken instance-attribute

withHttpOnlyToken: NotRequired[bool]

Whether to include HTTP-only authentication cookie

Request_getBoard

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getBoard

ATTRIBUTE	DESCRIPTION
subscribe	Whether to subscribe to real-time updates for this board (only for socket connections) TYPE: NotRequired[bool]

subscribe instance-attribute

subscribe: NotRequired[bool]

Whether to subscribe to real-time updates for this board (only for socket connections)

Request_getBoardActions

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getBoardActions

ATTRIBUTE	DESCRIPTION
beforeId	ID to get actions before (for pagination) TYPE: NotRequired[str]

beforeId instance-attribute

beforeId: NotRequired[str]

ID to get actions before (for pagination)

Request_getCardActions

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getCardActions

ATTRIBUTE	DESCRIPTION
beforeId	ID to get actions before (for pagination) TYPE: NotRequired[str]

beforeId instance-attribute

beforeId: NotRequired[str]

ID to get actions before (for pagination)

Request_getCards

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getCards

ATTRIBUTE	DESCRIPTION
before	Pagination cursor (JSON object with id and listChangedAt) TYPE: NotRequired[str]
labelIds	Comma-separated label IDs to filter by labels TYPE: NotRequired[str]
search	Search term to filter cards TYPE: NotRequired[str]
userIds	Comma-separated user IDs to filter by members TYPE: NotRequired[str]

before instance-attribute

before: NotRequired[str]

Pagination cursor (JSON object with id and listChangedAt)

labelIds instance-attribute

labelIds: NotRequired[str]

Comma-separated label IDs to filter by labels

search instance-attribute

search: NotRequired[str]

Search term to filter cards

userIds instance-attribute

userIds: NotRequired[str]

Comma-separated user IDs to filter by members

Request_getComments

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getComments

ATTRIBUTE	DESCRIPTION
beforeId	ID to get comments before (for pagination) TYPE: NotRequired[str]

beforeId instance-attribute

beforeId: NotRequired[str]

ID to get comments before (for pagination)

Request_getTerms

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getTerms

ATTRIBUTE	DESCRIPTION
language	Language code for terms localization TYPE: NotRequired[str]

language instance-attribute

language: NotRequired[str]

Language code for terms localization

Request_getUser

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getUser

ATTRIBUTE	DESCRIPTION
subscribe	Whether to subscribe to real-time updates for this user (only for socket connections) TYPE: NotRequired[bool]

subscribe instance-attribute

subscribe: NotRequired[bool]

Whether to subscribe to real-time updates for this user (only for socket connections)

Request_moveListCards

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  moveListCards

ATTRIBUTE	DESCRIPTION
listId	ID of the target list (must be an archive-type list) TYPE: str

listId instance-attribute

listId: str

ID of the target list (must be an archive-type list)

Request_revokePendingToken

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  revokePendingToken

ATTRIBUTE	DESCRIPTION
pendingToken	Pending token to revoke TYPE: str

pendingToken instance-attribute

pendingToken: str

Pending token to revoke

Request_sortList

Bases: TypedDict

Used by:

• Plankapy v2
  • models List  List  sort_cards
  • api Paths/Endpoints  PlankaEndpoints  sortList

ATTRIBUTE	DESCRIPTION
fieldName	Field to sort cards by TYPE: Literal['name', 'dueDate', 'createdAt']
order	Sorting order TYPE: NotRequired[Literal['asc', 'desc']]

fieldName instance-attribute

fieldName: Literal['name', 'dueDate', 'createdAt']

Field to sort cards by

order instance-attribute

order: NotRequired[Literal['asc', 'desc']]

Sorting order

Request_updateAttachment

Bases: TypedDict

Used by:

• Plankapy v2
  • models Attachment  Attachment  update
  • api Paths/Endpoints  PlankaEndpoints  updateAttachment

ATTRIBUTE	DESCRIPTION
name	Name/title of the attachment TYPE: NotRequired[str]

name instance-attribute

name: NotRequired[str]

Name/title of the attachment

Request_updateBaseCustomFieldGroup

Bases: TypedDict

Used by:

• Plankapy v2
  • models Base Custom Field Group  BaseCustomFieldGroup  update
  • api Paths/Endpoints  PlankaEndpoints  updateBaseCustomFieldGroup

ATTRIBUTE	DESCRIPTION
name	Name/title of the base custom field group TYPE: NotRequired[str]

name instance-attribute

name: NotRequired[str]

Name/title of the base custom field group

Request_updateBoard

Bases: TypedDict

Used by:

• Plankapy v2
  • models Board  Board  update
  • api Paths/Endpoints  PlankaEndpoints  updateBoard

ATTRIBUTE	DESCRIPTION
alwaysDisplayCardCreator	Whether to always display card creators TYPE: NotRequired[bool]
defaultCardType	Default card type for new cards TYPE: NotRequired[Literal['project', 'story']]
defaultView	Default view for the board TYPE: NotRequired[Literal['kanban', 'grid', 'list']]
expandTaskListsByDefault	Whether to expand task lists by default TYPE: NotRequired[bool]
isSubscribed	Whether the current user is subscribed to the board TYPE: NotRequired[bool]
limitCardTypesToDefaultOne	Whether to limit card types to default one TYPE: NotRequired[bool]
name	Name/title of the board TYPE: NotRequired[str]
position	Position of the board within the project TYPE: NotRequired[int]

alwaysDisplayCardCreator instance-attribute

alwaysDisplayCardCreator: NotRequired[bool]

Whether to always display card creators

defaultCardType instance-attribute

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

Default card type for new cards

defaultView instance-attribute

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

Default view for the board

expandTaskListsByDefault instance-attribute

expandTaskListsByDefault: NotRequired[bool]

Whether to expand task lists by default

isSubscribed instance-attribute

isSubscribed: NotRequired[bool]

Whether the current user is subscribed to the board

limitCardTypesToDefaultOne instance-attribute

limitCardTypesToDefaultOne: NotRequired[bool]

Whether to limit card types to default one

name instance-attribute

name: NotRequired[str]

Name/title of the board

position instance-attribute

position: NotRequired[int]

Position of the board within the project

Request_updateBoardMembership

Bases: TypedDict

Used by:

• Plankapy v2
  • models Board Membership  BoardMembership  update
  • api Paths/Endpoints  PlankaEndpoints  updateBoardMembership

ATTRIBUTE	DESCRIPTION
canComment	Whether the user can comment on cards (applies only to viewers) TYPE: NotRequired[bool | None]
role	Role of the user in the board TYPE: NotRequired[Literal['editor', 'viewer']]

canComment instance-attribute

canComment: NotRequired[bool | None]

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

role instance-attribute

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

Role of the user in the board

Request_updateCard

Bases: TypedDict

Used by:

• Plankapy v2
  • models Card  Card  update
  • api Paths/Endpoints  PlankaEndpoints  updateCard

ATTRIBUTE	DESCRIPTION
boardId	ID of the board to move the card to TYPE: NotRequired[str]
coverAttachmentId	ID of the attachment used as cover TYPE: NotRequired[str | None]
description	Detailed description of the card TYPE: NotRequired[str | None]
dueDate	Due date for the card TYPE: NotRequired[str | None]
isDueCompleted	Whether the due date is completed TYPE: NotRequired[bool | None]
isSubscribed	Whether the current user is subscribed to the card TYPE: NotRequired[bool]
listId	ID of the list to move the card to TYPE: NotRequired[str]
name	Name/title of the card TYPE: NotRequired[str]
position	Position of the card within the list TYPE: NotRequired[int | None]
stopwatch	Stopwatch data for time tracking TYPE: NotRequired[Stopwatch | None]
type	Type of the card TYPE: NotRequired[Literal['project', 'story']]

boardId instance-attribute

boardId: NotRequired[str]

ID of the board to move the card to

coverAttachmentId instance-attribute

coverAttachmentId: NotRequired[str | None]

ID of the attachment used as cover

description instance-attribute

description: NotRequired[str | None]

Detailed description of the card

dueDate instance-attribute

dueDate: NotRequired[str | None]

Due date for the card

isDueCompleted instance-attribute

isDueCompleted: NotRequired[bool | None]

Whether the due date is completed

isSubscribed instance-attribute

isSubscribed: NotRequired[bool]

Whether the current user is subscribed to the card

listId instance-attribute

listId: NotRequired[str]

ID of the list to move the card to

name instance-attribute

name: NotRequired[str]

Name/title of the card

position instance-attribute

position: NotRequired[int | None]

Position of the card within the list

stopwatch instance-attribute

stopwatch: NotRequired[Stopwatch | None]

Stopwatch data for time tracking

type instance-attribute

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

Type of the card

Request_updateComments

Bases: TypedDict

Used by:

• Plankapy v2
  • models Comment  Comment  update
  • api Paths/Endpoints  PlankaEndpoints  updateComments

ATTRIBUTE	DESCRIPTION
text	Content of the comment TYPE: NotRequired[str]

text instance-attribute

text: NotRequired[str]

Content of the comment

Request_updateCustomField

Bases: TypedDict

Used by:

• Plankapy v2
  • models Custom Field  CustomField  update
  • api Paths/Endpoints  PlankaEndpoints  updateCustomField

ATTRIBUTE	DESCRIPTION
name	Name/title of the custom field TYPE: NotRequired[str]
position	Position of the custom field within the group TYPE: NotRequired[int]
showOnFrontOfCard	Whether to show the field on the front of cards TYPE: NotRequired[bool]

name instance-attribute

name: NotRequired[str]

Name/title of the custom field

position instance-attribute

position: NotRequired[int]

Position of the custom field within the group

showOnFrontOfCard instance-attribute

showOnFrontOfCard: NotRequired[bool]

Whether to show the field on the front of cards

Request_updateCustomFieldGroup

Bases: TypedDict

Used by:

• Plankapy v2
  • models Custom Field Group  CustomFieldGroup  update
  • api Paths/Endpoints  PlankaEndpoints  updateCustomFieldGroup

ATTRIBUTE	DESCRIPTION
name	Name/title of the custom field group TYPE: NotRequired[str | None]
position	Position of the custom field group within the board/card TYPE: NotRequired[int]

name instance-attribute

name: NotRequired[str | None]

Name/title of the custom field group

position instance-attribute

position: NotRequired[int]

Position of the custom field group within the board/card

Request_updateCustomFieldValue

Bases: TypedDict

Used by:

• Plankapy v2
  • models Custom Field Value  CustomFieldValue  update
  • api Paths/Endpoints  PlankaEndpoints  updateCustomFieldValue

ATTRIBUTE	DESCRIPTION
content	Content/value of the custom field TYPE: str

content instance-attribute

content: str

Content/value of the custom field

Request_updateLabel

Bases: TypedDict

Used by:

• Plankapy v2
  • models Label  Label  update
  • api Paths/Endpoints  PlankaEndpoints  updateLabel

ATTRIBUTE	DESCRIPTION
color	Color of the label TYPE: NotRequired[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']]
name	Name/title of the label TYPE: NotRequired[str | None]
position	Position of the label within the board TYPE: NotRequired[int]

color instance-attribute

color: NotRequired[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

name instance-attribute

name: NotRequired[str | None]

Name/title of the label

position instance-attribute

position: NotRequired[int]

Position of the label within the board

Request_updateList

Bases: TypedDict

Used by:

• Plankapy v2
  • models List  List  update
  • api Paths/Endpoints  PlankaEndpoints  updateList

ATTRIBUTE	DESCRIPTION
boardId	ID of the board to move list to TYPE: NotRequired[str]
color	Color for the list TYPE: NotRequired[Literal['berry-red', 'pumpkin-orange', 'lagoon-blue', 'pink-tulip', 'light-mud', 'orange-peel', 'bright-moss', 'antique-blue', 'dark-granite', 'turquoise-sea'] | None]
name	Name/title of the list TYPE: NotRequired[str]
position	Position of the list within the board TYPE: NotRequired[int]
type	Type/status of the list TYPE: NotRequired[Literal['active', 'closed']]

boardId instance-attribute

boardId: NotRequired[str]

ID of the board to move list to

color instance-attribute

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

Color for the list

name instance-attribute

name: NotRequired[str]

Name/title of the list

position instance-attribute

position: NotRequired[int]

Position of the list within the board

type instance-attribute

type: NotRequired[Literal['active', 'closed']]

Type/status of the list

Request_updateNotification

Bases: TypedDict

Used by:

• Plankapy v2
  • models Notification  Notification  update
  • api Paths/Endpoints  PlankaEndpoints  updateNotification

ATTRIBUTE	DESCRIPTION
isRead	Whether the notification has been read TYPE: NotRequired[bool]

isRead instance-attribute

isRead: NotRequired[bool]

Whether the notification has been read

Request_updateNotificationService

Bases: TypedDict

Used by:

• Plankapy v2
  • models Notification Service  NotificationService  update
  • api Paths/Endpoints  PlankaEndpoints  updateNotificationService

ATTRIBUTE	DESCRIPTION
format	Format for notification messages TYPE: NotRequired[Literal['text', 'markdown', 'html']]
url	URL endpoint for notifications TYPE: NotRequired[str]

format instance-attribute

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

Format for notification messages

url instance-attribute

url: NotRequired[str]

URL endpoint for notifications

Request_updateProject

Bases: TypedDict

Used by:

• Plankapy v2
  • api Paths/Endpoints  PlankaEndpoints  updateProject
  • models Project  Project  update

ATTRIBUTE	DESCRIPTION
backgroundGradient	Gradient background for the project TYPE: NotRequired[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'] | None]
backgroundImageId	ID of the background image used as background TYPE: NotRequired[str | None]
backgroundType	Type of background for the project TYPE: NotRequired[Literal['gradient', 'image'] | None]
description	Detailed description of the project TYPE: NotRequired[str | None]
isFavorite	Whether the project is marked as favorite by the current user TYPE: NotRequired[bool]
isHidden	Whether the project is hidden TYPE: NotRequired[bool]
name	Name/title of the project TYPE: NotRequired[str]
ownerProjectManagerId	ID of the project manager who owns the project TYPE: NotRequired[str | None]

backgroundGradient instance-attribute

backgroundGradient: NotRequired[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'] | None]

Gradient background for the project

backgroundImageId instance-attribute

backgroundImageId: NotRequired[str | None]

ID of the background image used as background

backgroundType instance-attribute

backgroundType: NotRequired[Literal['gradient', 'image'] | None]

Type of background for the project

description instance-attribute

description: NotRequired[str | None]

Detailed description of the project

isFavorite instance-attribute

isFavorite: NotRequired[bool]

Whether the project is marked as favorite by the current user

isHidden instance-attribute

isHidden: NotRequired[bool]

Whether the project is hidden

name instance-attribute

name: NotRequired[str]

Name/title of the project

ownerProjectManagerId instance-attribute

ownerProjectManagerId: NotRequired[str | None]

ID of the project manager who owns the project

Request_updateTask

Bases: TypedDict

Used by:

• Plankapy v2
  • api Paths/Endpoints  PlankaEndpoints  updateTask
  • models Task  Task  update

ATTRIBUTE	DESCRIPTION
assigneeUserId	ID of the user assigned to the task (null to unassign) TYPE: NotRequired[str | None]
isCompleted	Whether the task is completed TYPE: NotRequired[bool]
name	Name/title of the task TYPE: NotRequired[str]
position	Position of the task within the task list TYPE: NotRequired[int]
taskListId	ID of the task list to move the task to TYPE: NotRequired[str]

assigneeUserId instance-attribute

assigneeUserId: NotRequired[str | None]

ID of the user assigned to the task (null to unassign)

isCompleted instance-attribute

isCompleted: NotRequired[bool]

Whether the task is completed

name instance-attribute

name: NotRequired[str]

Name/title of the task

position instance-attribute

position: NotRequired[int]

Position of the task within the task list

taskListId instance-attribute

taskListId: NotRequired[str]

ID of the task list to move the task to

Request_updateTaskList

Bases: TypedDict

Used by:

• Plankapy v2
  • api Paths/Endpoints  PlankaEndpoints  updateTaskList
  • models Task List  TaskList  update

ATTRIBUTE	DESCRIPTION
hideCompletedTasks	Whether to hide completed tasks TYPE: NotRequired[bool]
name	Name/title of the task list TYPE: NotRequired[str]
position	Position of the task list within the card TYPE: NotRequired[int]
showOnFrontOfCard	Whether to show the task list on the front of the card TYPE: NotRequired[bool]

hideCompletedTasks instance-attribute

hideCompletedTasks: NotRequired[bool]

Whether to hide completed tasks

name instance-attribute

name: NotRequired[str]

Name/title of the task list

position instance-attribute

position: NotRequired[int]

Position of the task list within the card

showOnFrontOfCard instance-attribute

showOnFrontOfCard: NotRequired[bool]

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

Request_updateUser

Bases: TypedDict

Used by:

• Plankapy v2
  • api Paths/Endpoints  PlankaEndpoints  updateUser
  • models User  User  update

ATTRIBUTE	DESCRIPTION
avatar	Avatar of the user (only null value to remove avatar) TYPE: NotRequired[dict[str, Any] | None]
defaultEditorMode	Default markdown editor mode TYPE: NotRequired[Literal['wysiwyg', 'markup']]
defaultHomeView	Default view mode for the home page TYPE: NotRequired[Literal['gridProjects', 'groupedProjects']]
defaultProjectsOrder	Default sort order for projects display TYPE: NotRequired[Literal['byDefault', 'alphabetically', 'byCreationTime']]
enableFavoritesByDefault	Whether favorites are enabled by default TYPE: NotRequired[bool]
isDeactivated	Whether the user account is deactivated and cannot log in (for admins) TYPE: NotRequired[bool]
language	Preferred language for user interface and notifications 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'] | None]
name	Full display name of the user TYPE: NotRequired[str]
organization	Organization or company name TYPE: NotRequired[str | None]
phone	Contact phone number TYPE: NotRequired[str | None]
role	User role defining access permissions TYPE: NotRequired[Literal['admin', 'projectOwner', 'boardUser']]
subscribeToCardWhenCommenting	Whether the user subscribes to cards when commenting TYPE: NotRequired[bool]
subscribeToOwnCards	Whether the user subscribes to their own cards TYPE: NotRequired[bool]
turnOffRecentCardHighlighting	Whether recent card highlighting is disabled TYPE: NotRequired[bool]

avatar instance-attribute

avatar: NotRequired[dict[str, Any] | None]

Avatar of the user (only null value to remove avatar)

defaultEditorMode instance-attribute

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

Default markdown editor mode

defaultHomeView instance-attribute

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

Default view mode for the home page

defaultProjectsOrder instance-attribute

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

Default sort order for projects display

enableFavoritesByDefault instance-attribute

enableFavoritesByDefault: NotRequired[bool]

Whether favorites are enabled by default

isDeactivated instance-attribute

isDeactivated: NotRequired[bool]

Whether the user account is deactivated and cannot log in (for admins)

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'] | None]

Preferred language for user interface and notifications

name instance-attribute

name: NotRequired[str]

Full display name of the user

organization instance-attribute

organization: NotRequired[str | None]

Organization or company name

phone instance-attribute

phone: NotRequired[str | None]

Contact phone number

role instance-attribute

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

User role defining access permissions

subscribeToCardWhenCommenting instance-attribute

subscribeToCardWhenCommenting: NotRequired[bool]

Whether the user subscribes to cards when commenting

subscribeToOwnCards instance-attribute

subscribeToOwnCards: NotRequired[bool]

Whether the user subscribes to their own cards

turnOffRecentCardHighlighting instance-attribute

turnOffRecentCardHighlighting: NotRequired[bool]

Whether recent card highlighting is disabled

Request_updateUserAvatar

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateUserAvatar

ATTRIBUTE	DESCRIPTION
file	Avatar image file (must be an image format) TYPE: bytes

file instance-attribute

file: bytes

Avatar image file (must be an image format)

Request_updateUserEmail

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateUserEmail

ATTRIBUTE	DESCRIPTION
currentPassword	Current password (required when updating own email) TYPE: NotRequired[str]
email	Email address for login and notifications TYPE: str

currentPassword instance-attribute

currentPassword: NotRequired[str]

Current password (required when updating own email)

email instance-attribute

email: str

Email address for login and notifications

Request_updateUserPassword

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateUserPassword

ATTRIBUTE	DESCRIPTION
currentPassword	Current password (required when updating own password) TYPE: NotRequired[str]
password	Password (must meet password requirements) TYPE: str

currentPassword instance-attribute

currentPassword: NotRequired[str]

Current password (required when updating own password)

password instance-attribute

password: str

Password (must meet password requirements)

Request_updateUserUsername

Bases: TypedDict

Used by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateUserUsername

ATTRIBUTE	DESCRIPTION
currentPassword	Current password (required when updating own username) TYPE: NotRequired[str]
username	Unique username for user identification TYPE: NotRequired[str | None]

currentPassword instance-attribute

currentPassword: NotRequired[str]

Current password (required when updating own username)

username instance-attribute

username: NotRequired[str | None]

Unique username for user identification

Request_updateWebhook

Bases: TypedDict

Used by:

• Plankapy v2
  • api Paths/Endpoints  PlankaEndpoints  updateWebhook
  • models Webhook  Webhook  update

ATTRIBUTE	DESCRIPTION
accessToken	Access token for webhook authentication TYPE: NotRequired[str | None]
events	Comma-separated list of events that trigger the webhook TYPE: NotRequired[str | None]
excludedEvents	Comma-separated list of events excluded from the webhook TYPE: NotRequired[str | None]
name	Name/title of the webhook TYPE: NotRequired[str]
url	URL endpoint for the webhook TYPE: NotRequired[str]

accessToken instance-attribute

accessToken: NotRequired[str | None]

Access token for webhook authentication

events instance-attribute

events: NotRequired[str | None]

Comma-separated list of events that trigger the webhook

excludedEvents instance-attribute

excludedEvents: NotRequired[str | None]

Comma-separated list of events excluded from the webhook

name instance-attribute

name: NotRequired[str]

Name/title of the webhook

url instance-attribute

url: NotRequired[str]

URL endpoint for the webhook

Response_acceptTerms

Bases: TypedDict

Terms accepted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  acceptTerms

ATTRIBUTE	DESCRIPTION
item	Access token for API authentication TYPE: str

item instance-attribute

item: str

Access token for API authentication

Response_clearList

Bases: TypedDict

List cleared successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  clearList

ATTRIBUTE	DESCRIPTION
item	TYPE: List

item instance-attribute

item: List

Response_createAccessToken

Bases: TypedDict

Login successful

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createAccessToken

ATTRIBUTE	DESCRIPTION
item	Access token for API authentication TYPE: str

item instance-attribute

item: str

Access token for API authentication

Response_createAttachment

Bases: TypedDict

Attachment created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createAttachment

ATTRIBUTE	DESCRIPTION
item	TYPE: Attachment

item instance-attribute

item: Attachment

Response_createBackgroundImage

Bases: TypedDict

Background image uploaded successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createBackgroundImage

ATTRIBUTE	DESCRIPTION
item	TYPE: BackgroundImage

item instance-attribute

item: BackgroundImage

Response_createBaseCustomFieldGroup

Bases: TypedDict

Base custom field group created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createBaseCustomFieldGroup

ATTRIBUTE	DESCRIPTION
item	TYPE: BaseCustomFieldGroup

item instance-attribute

item: BaseCustomFieldGroup

Response_createBoard

Bases: TypedDict

Board created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createBoard

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_createBoard
item	TYPE: Board

included instance-attribute

included: Included_createBoard

item instance-attribute

item: Board

Response_createBoardCustomFieldGroup

Bases: TypedDict

Custom field group created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createBoardCustomFieldGroup

ATTRIBUTE	DESCRIPTION
item	TYPE: CustomFieldGroup

item instance-attribute

item: CustomFieldGroup

Response_createBoardMembership

Bases: TypedDict

Board membership created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createBoardMembership

ATTRIBUTE	DESCRIPTION
item	TYPE: BoardMembership

item instance-attribute

item: BoardMembership

Response_createBoardNotificationService

Bases: TypedDict

Notification service created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createBoardNotificationService

ATTRIBUTE	DESCRIPTION
item	TYPE: NotificationService

item instance-attribute

item: NotificationService

Response_createCard

Bases: TypedDict

Card created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createCard

ATTRIBUTE	DESCRIPTION
item	TYPE: Card

item instance-attribute

item: Card

Response_createCardCustomFieldGroup

Bases: TypedDict

Custom field group created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createCardCustomFieldGroup

ATTRIBUTE	DESCRIPTION
item	TYPE: CustomFieldGroup

item instance-attribute

item: CustomFieldGroup

Response_createCardLabel

Bases: TypedDict

Label added to card successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createCardLabel

ATTRIBUTE	DESCRIPTION
item	TYPE: CardLabel

item instance-attribute

item: CardLabel

Response_createCardMembership

Bases: TypedDict

User added to card successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createCardMembership

ATTRIBUTE	DESCRIPTION
item	TYPE: CardMembership

item instance-attribute

item: CardMembership

Response_createComment

Bases: TypedDict

Comment created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createComment

ATTRIBUTE	DESCRIPTION
item	TYPE: Comment

item instance-attribute

item: Comment

Response_createCustomFieldInBaseGroup

Bases: TypedDict

Custom field created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createCustomFieldInBaseGroup

ATTRIBUTE	DESCRIPTION
item	TYPE: CustomField

item instance-attribute

item: CustomField

Response_createCustomFieldInGroup

Bases: TypedDict

Custom field created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createCustomFieldInGroup

ATTRIBUTE	DESCRIPTION
item	TYPE: CustomField

item instance-attribute

item: CustomField

Response_createLabel

Bases: TypedDict

Label created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createLabel

ATTRIBUTE	DESCRIPTION
item	TYPE: Label

item instance-attribute

item: Label

Response_createList

Bases: TypedDict

List created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createList

ATTRIBUTE	DESCRIPTION
item	TYPE: List

item instance-attribute

item: List

Response_createProject

Bases: TypedDict

Project created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createProject

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_createProject
item	TYPE: Project

included instance-attribute

included: Included_createProject

item instance-attribute

item: Project

Response_createProjectManager

Bases: TypedDict

Project manager created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createProjectManager

ATTRIBUTE	DESCRIPTION
item	TYPE: ProjectManager

item instance-attribute

item: ProjectManager

Response_createTask

Bases: TypedDict

Task created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createTask

ATTRIBUTE	DESCRIPTION
item	TYPE: Task

item instance-attribute

item: Task

Response_createTaskList

Bases: TypedDict

Task list created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createTaskList

ATTRIBUTE	DESCRIPTION
item	TYPE: TaskList

item instance-attribute

item: TaskList

Response_createUser

Bases: TypedDict

User created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createUser

ATTRIBUTE	DESCRIPTION
item	TYPE: User

item instance-attribute

item: User

Response_createUserNotificationService

Bases: TypedDict

Notification service created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createUserNotificationService

ATTRIBUTE	DESCRIPTION
item	TYPE: NotificationService

item instance-attribute

item: NotificationService

Response_createWebhook

Bases: TypedDict

Webhook created successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  createWebhook

ATTRIBUTE	DESCRIPTION
item	TYPE: Webhook

item instance-attribute

item: Webhook

Response_deleteAccessToken

Bases: TypedDict

Logout successful

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteAccessToken

ATTRIBUTE	DESCRIPTION
item	Revoked access token TYPE: str

item instance-attribute

item: str

Revoked access token

Response_deleteAttachment

Bases: TypedDict

Attachment deleted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteAttachment

ATTRIBUTE	DESCRIPTION
item	TYPE: Attachment

item instance-attribute

item: Attachment

Response_deleteBackgroundImage

Bases: TypedDict

Background image deleted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteBackgroundImage

ATTRIBUTE	DESCRIPTION
item	TYPE: BackgroundImage

item instance-attribute

item: BackgroundImage

Response_deleteBaseCustomFieldGroup

Bases: TypedDict

Base custom field group deleted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteBaseCustomFieldGroup

ATTRIBUTE	DESCRIPTION
item	TYPE: BaseCustomFieldGroup

item instance-attribute

item: BaseCustomFieldGroup

Response_deleteBoard

Bases: TypedDict

Board deleted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteBoard

ATTRIBUTE	DESCRIPTION
item	TYPE: Board

item instance-attribute

item: Board

Response_deleteBoardMembership

Bases: TypedDict

Board membership deleted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteBoardMembership

ATTRIBUTE	DESCRIPTION
item	TYPE: BoardMembership

item instance-attribute

item: BoardMembership

Response_deleteCard

Bases: TypedDict

Card deleted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteCard

ATTRIBUTE	DESCRIPTION
item	TYPE: Card

item instance-attribute

item: Card

Response_deleteCardLabel

Bases: TypedDict

Label removed from card successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteCardLabel

ATTRIBUTE	DESCRIPTION
item	TYPE: CardLabel

item instance-attribute

item: CardLabel

Response_deleteCardMembership

Bases: TypedDict

User removed from card successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteCardMembership

ATTRIBUTE	DESCRIPTION
item	TYPE: CardMembership

item instance-attribute

item: CardMembership

Response_deleteComment

Bases: TypedDict

Comment deleted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteComment

ATTRIBUTE	DESCRIPTION
item	TYPE: Comment

item instance-attribute

item: Comment

Response_deleteCustomField

Bases: TypedDict

Custom field deleted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteCustomField

ATTRIBUTE	DESCRIPTION
item	TYPE: CustomField

item instance-attribute

item: CustomField

Response_deleteCustomFieldGroup

Bases: TypedDict

Custom field group deleted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteCustomFieldGroup

ATTRIBUTE	DESCRIPTION
item	TYPE: CustomFieldGroup

item instance-attribute

item: CustomFieldGroup

Response_deleteCustomFieldValue

Bases: TypedDict

Custom field value deleted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteCustomFieldValue

ATTRIBUTE	DESCRIPTION
item	TYPE: CustomFieldValue

item instance-attribute

item: CustomFieldValue

Response_deleteLabel

Bases: TypedDict

Label deleted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteLabel

ATTRIBUTE	DESCRIPTION
item	TYPE: Label

item instance-attribute

item: Label

Response_deleteList

Bases: TypedDict

List deleted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteList

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_deleteList
item	TYPE: List

included instance-attribute

included: Included_deleteList

item instance-attribute

item: List

Response_deleteNotificationService

Bases: TypedDict

Notification service deleted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteNotificationService

ATTRIBUTE	DESCRIPTION
item	TYPE: NotificationService

item instance-attribute

item: NotificationService

Response_deleteProject

Bases: TypedDict

Project deleted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteProject

ATTRIBUTE	DESCRIPTION
item	TYPE: Project

item instance-attribute

item: Project

Response_deleteProjectManager

Bases: TypedDict

Project manager deleted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteProjectManager

ATTRIBUTE	DESCRIPTION
item	TYPE: ProjectManager

item instance-attribute

item: ProjectManager

Response_deleteTask

Bases: TypedDict

Task deleted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteTask

ATTRIBUTE	DESCRIPTION
item	TYPE: Task

item instance-attribute

item: Task

Response_deleteTaskList

Bases: TypedDict

Task list deleted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteTaskList

ATTRIBUTE	DESCRIPTION
item	TYPE: TaskList

item instance-attribute

item: TaskList

Response_deleteUser

Bases: TypedDict

User deleted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteUser

ATTRIBUTE	DESCRIPTION
item	TYPE: User

item instance-attribute

item: User

Response_deleteWebhook

Bases: TypedDict

Webhook deleted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  deleteWebhook

ATTRIBUTE	DESCRIPTION
item	TYPE: Webhook

item instance-attribute

item: Webhook

Response_duplicateCard

Bases: TypedDict

Card duplicated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  duplicateCard

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_duplicateCard
item	TYPE: Card

included instance-attribute

included: Included_duplicateCard

item instance-attribute

item: Card

Response_exchangeForAccessTokenWithOidc

Bases: TypedDict

OIDC exchange successful

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  exchangeForAccessTokenWithOidc

ATTRIBUTE	DESCRIPTION
item	Access token for API authentication TYPE: str

item instance-attribute

item: str

Access token for API authentication

Response_getBoard

Bases: TypedDict

Board details retrieved successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getBoard

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_getBoard
item	TYPE: Item_getBoard

included instance-attribute

included: Included_getBoard

item instance-attribute

item: Item_getBoard

Response_getBoardActions

Bases: TypedDict

Board actions retrieved successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getBoardActions

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_getBoardActions
items	TYPE: list[Action]

included instance-attribute

included: Included_getBoardActions

items instance-attribute

items: list[Action]

Response_getCard

Bases: TypedDict

Card details retrieved successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getCard

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_getCard
item	TYPE: Item_getCard

included instance-attribute

included: Included_getCard

item instance-attribute

item: Item_getCard

Response_getCardActions

Bases: TypedDict

Card actions retrieved successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getCardActions

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_getCardActions
items	TYPE: list[Action]

included instance-attribute

included: Included_getCardActions

items instance-attribute

items: list[Action]

Response_getCards

Bases: TypedDict

Cards retrieved successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getCards

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_getCards
items	TYPE: list[Items_getCards]

included instance-attribute

included: Included_getCards

items instance-attribute

items: list[Items_getCards]

Response_getComments

Bases: TypedDict

Comments retrieved successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getComments

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_getComments
items	TYPE: list[Comment]

included instance-attribute

included: Included_getComments

items instance-attribute

items: list[Comment]

Response_getConfig

Bases: TypedDict

Configuration retrieved successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getConfig

ATTRIBUTE	DESCRIPTION
item	TYPE: Config

item instance-attribute

item: Config

Response_getCustomFieldGroup

Bases: TypedDict

Custom field group details retrieved successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getCustomFieldGroup

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_getCustomFieldGroup
item	TYPE: CustomFieldGroup

included instance-attribute

included: Included_getCustomFieldGroup

item instance-attribute

item: CustomFieldGroup

Response_getList

Bases: TypedDict

List details retrieved successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getList

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_getList
item	TYPE: List

included instance-attribute

included: Included_getList

item instance-attribute

item: List

Response_getNotification

Bases: TypedDict

Notification details retrieved successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getNotification

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_getNotification
item	TYPE: Notification

included instance-attribute

included: Included_getNotification

item instance-attribute

item: Notification

Response_getNotifications

Bases: TypedDict

Notifications retrieved successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getNotifications

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_getNotifications
items	TYPE: list[Notification]

included instance-attribute

included: Included_getNotifications

items instance-attribute

items: list[Notification]

Response_getProject

Bases: TypedDict

Project details retrieved successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getProject

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_getProject
item	TYPE: Item_getProject

included instance-attribute

included: Included_getProject

item instance-attribute

item: Item_getProject

Response_getProjects

Bases: TypedDict

Projects retrieved successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getProjects

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_getProjects
items	TYPE: list[Items_getProjects]

included instance-attribute

included: Included_getProjects

items instance-attribute

items: list[Items_getProjects]

Response_getTaskList

Bases: TypedDict

Task list details retrieved successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getTaskList

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_getTaskList
item	TYPE: TaskList

included instance-attribute

included: Included_getTaskList

item instance-attribute

item: TaskList

Response_getTerms

Bases: TypedDict

Terms content retrieved successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getTerms

ATTRIBUTE	DESCRIPTION
item	TYPE: Item_getTerms

item instance-attribute

item: Item_getTerms

Response_getUser

Bases: TypedDict

User details retrieved successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getUser

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_getUser
item	TYPE: User

included instance-attribute

included: Included_getUser

item instance-attribute

item: User

Response_getUsers

Bases: TypedDict

List of users retrieved successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getUsers

ATTRIBUTE	DESCRIPTION
items	TYPE: list[User]

items instance-attribute

items: list[User]

Response_getWebhooks

Bases: TypedDict

List of webhooks retrieved successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  getWebhooks

ATTRIBUTE	DESCRIPTION
items	TYPE: list[Webhook]

items instance-attribute

items: list[Webhook]

Response_moveListCards

Bases: TypedDict

Cards moved successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  moveListCards

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_moveListCards
item	TYPE: List

included instance-attribute

included: Included_moveListCards

item instance-attribute

item: List

Response_readAllNotifications

Bases: TypedDict

Notifications marked as read successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  readAllNotifications

ATTRIBUTE	DESCRIPTION
items	TYPE: list[Notification]

items instance-attribute

items: list[Notification]

Response_readCardNotifications

Bases: TypedDict

Notifications marked as read successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  readCardNotifications

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_readCardNotifications
item	TYPE: Card

included instance-attribute

included: Included_readCardNotifications

item instance-attribute

item: Card

Response_revokePendingToken

Bases: TypedDict

Pending token revoked successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  revokePendingToken

ATTRIBUTE	DESCRIPTION
item	No data returned TYPE: dict[str, Any] | None

item instance-attribute

item: dict[str, Any] | None

No data returned

Response_sortList

Bases: TypedDict

List sorted successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  sortList

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_sortList
item	TYPE: List

included instance-attribute

included: Included_sortList

item instance-attribute

item: List

Response_testNotificationService

Bases: TypedDict

Test notification sent successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  testNotificationService

ATTRIBUTE	DESCRIPTION
item	TYPE: NotificationService

item instance-attribute

item: NotificationService

Response_updateAttachment

Bases: TypedDict

Attachment updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateAttachment

ATTRIBUTE	DESCRIPTION
item	TYPE: Attachment

item instance-attribute

item: Attachment

Response_updateBaseCustomFieldGroup

Bases: TypedDict

Base custom field group updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateBaseCustomFieldGroup

ATTRIBUTE	DESCRIPTION
item	TYPE: BaseCustomFieldGroup

item instance-attribute

item: BaseCustomFieldGroup

Response_updateBoard

Bases: TypedDict

Board updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateBoard

ATTRIBUTE	DESCRIPTION
item	TYPE: Board

item instance-attribute

item: Board

Response_updateBoardMembership

Bases: TypedDict

Board membership updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateBoardMembership

ATTRIBUTE	DESCRIPTION
item	TYPE: BoardMembership

item instance-attribute

item: BoardMembership

Response_updateCard

Bases: TypedDict

Card updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateCard

ATTRIBUTE	DESCRIPTION
item	TYPE: Card

item instance-attribute

item: Card

Response_updateComments

Bases: TypedDict

Comment updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateComments

ATTRIBUTE	DESCRIPTION
item	TYPE: Comment

item instance-attribute

item: Comment

Response_updateCustomField

Bases: TypedDict

Custom field updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateCustomField

ATTRIBUTE	DESCRIPTION
item	TYPE: CustomField

item instance-attribute

item: CustomField

Response_updateCustomFieldGroup

Bases: TypedDict

Custom field group updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateCustomFieldGroup

ATTRIBUTE	DESCRIPTION
item	TYPE: CustomFieldGroup

item instance-attribute

item: CustomFieldGroup

Response_updateCustomFieldValue

Bases: TypedDict

Custom field value created or updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateCustomFieldValue

ATTRIBUTE	DESCRIPTION
item	TYPE: CustomFieldValue

item instance-attribute

item: CustomFieldValue

Response_updateLabel

Bases: TypedDict

Label updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateLabel

ATTRIBUTE	DESCRIPTION
item	TYPE: Label

item instance-attribute

item: Label

Response_updateList

Bases: TypedDict

List updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateList

ATTRIBUTE	DESCRIPTION
item	TYPE: List

item instance-attribute

item: List

Response_updateNotification

Bases: TypedDict

Notification updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateNotification

ATTRIBUTE	DESCRIPTION
item	TYPE: Notification

item instance-attribute

item: Notification

Response_updateNotificationService

Bases: TypedDict

Notification service updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateNotificationService

ATTRIBUTE	DESCRIPTION
item	TYPE: NotificationService

item instance-attribute

item: NotificationService

Response_updateProject

Bases: TypedDict

Project updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateProject

ATTRIBUTE	DESCRIPTION
item	TYPE: Project

item instance-attribute

item: Project

Response_updateTask

Bases: TypedDict

Task updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateTask

ATTRIBUTE	DESCRIPTION
item	TYPE: Task

item instance-attribute

item: Task

Response_updateTaskList

Bases: TypedDict

Task list updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateTaskList

ATTRIBUTE	DESCRIPTION
item	TYPE: TaskList

item instance-attribute

item: TaskList

Response_updateUser

Bases: TypedDict

User updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateUser

ATTRIBUTE	DESCRIPTION
item	TYPE: User

item instance-attribute

item: User

Response_updateUserAvatar

Bases: TypedDict

Avatar updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateUserAvatar

ATTRIBUTE	DESCRIPTION
item	TYPE: User

item instance-attribute

item: User

Response_updateUserEmail

Bases: TypedDict

Email updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateUserEmail

ATTRIBUTE	DESCRIPTION
item	TYPE: User

item instance-attribute

item: User

Response_updateUserPassword

Bases: TypedDict

Password updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateUserPassword

ATTRIBUTE	DESCRIPTION
included	TYPE: Included_updateUserPassword
item	TYPE: User

included instance-attribute

included: Included_updateUserPassword

item instance-attribute

item: User

Response_updateUserUsername

Bases: TypedDict

Username updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateUserUsername

ATTRIBUTE	DESCRIPTION
item	TYPE: User

item instance-attribute

item: User

Response_updateWebhook

Bases: TypedDict

Webhook updated successfully

Returned by:

• Plankapy v2 api Paths/Endpoints  PlankaEndpoints  updateWebhook

ATTRIBUTE	DESCRIPTION
item	TYPE: Webhook

item instance-attribute

item: Webhook

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