PLANKA · JSON-LD Context
Planka Context
JSON-LD context defining the semantic vocabulary for Planka from PLANKA.
24 Classes
84 Properties
4 Namespaces
Namespaces
schema:
https://schema.org/
xsd:
http://www.w3.org/2001/XMLSchema#
dcterms:
http://purl.org/dc/terms/
planka:
https://planka.app/schema#
Classes
Action
Attachment
BackgroundImage
BaseCustomFieldGroup
Board
BoardMembership
Card
CardLabel
CardMembership
Comment
Config
CustomField
CustomFieldGroup
CustomFieldValue
Label
List
Notification
NotificationService
Project
ProjectManager
Task
TaskList
User
Webhook
Properties
| Property | Type | Container |
|---|---|---|
| id | string | |
| boardId | string | |
| cardId | string | |
| userId | string | |
| type | string | |
| data | ||
| createdAt | dateTime | |
| updatedAt | dateTime | |
| creatorUserId | string | |
| name | string | |
| projectId | string | |
| size | string | |
| url | reference | |
| thumbnailUrls | ||
| position | decimal | |
| defaultView | string | |
| defaultCardType | string | |
| limitCardTypesToDefaultOne | boolean | |
| alwaysDisplayCardCreator | boolean | |
| expandTaskListsByDefault | boolean | |
| role | string | |
| canComment | boolean | |
| listId | string | |
| prevListId | string | |
| coverAttachmentId | string | |
| description | string | |
| dueDate | dateTime | |
| isDueCompleted | boolean | |
| stopwatch | ||
| commentsTotal | decimal | |
| isClosed | boolean | |
| listChangedAt | dateTime | |
| labelId | string | |
| text | string | |
| smtpHost | string | |
| smtpPort | decimal | |
| smtpName | string | |
| smtpSecure | boolean | |
| smtpTlsRejectUnauthorized | boolean | |
| smtpUser | string | |
| smtpPassword | string | |
| smtpFrom | string | |
| baseCustomFieldGroupId | string | |
| customFieldGroupId | string | |
| showOnFrontOfCard | boolean | |
| customFieldId | string | |
| content | string | |
| color | string | |
| commentId | string | |
| actionId | string | |
| isRead | boolean | |
| format | string | |
| ownerProjectManagerId | string | |
| backgroundImageId | string | |
| backgroundType | string | |
| backgroundGradient | string | |
| isHidden | boolean | |
| taskListId | string | |
| linkedCardId | string | |
| assigneeUserId | string | |
| isCompleted | boolean | |
| hideCompletedTasks | boolean | |
| string | ||
| username | string | |
| avatar | ||
| gravatarUrl | reference | |
| phone | string | |
| organization | string | |
| language | string | |
| apiKeyPrefix | string | |
| subscribeToOwnCards | boolean | |
| subscribeToCardWhenCommenting | boolean | |
| turnOffRecentCardHighlighting | boolean | |
| enableFavoritesByDefault | boolean | |
| defaultEditorMode | string | |
| defaultHomeView | string | |
| defaultProjectsOrder | string | |
| isSsoUser | boolean | |
| isDeactivated | boolean | |
| isDefaultAdmin | boolean | |
| lockedFieldNames | list | |
| accessToken | string | |
| events | list | |
| excludedEvents | list |
JSON-LD Document
{
"@context": {
"@vocab": "https://planka.app/schema#",
"schema": "https://schema.org/",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"dcterms": "http://purl.org/dc/terms/",
"planka": "https://planka.app/schema#",
"Action": "planka:Action",
"id": {
"@id": "planka:id",
"@type": "xsd:string"
},
"boardId": {
"@id": "planka:boardId",
"@type": "xsd:string"
},
"cardId": {
"@id": "planka:cardId",
"@type": "xsd:string"
},
"userId": {
"@id": "planka:userId",
"@type": "xsd:string"
},
"type": {
"@id": "planka:type",
"@type": "xsd:string"
},
"data": {
"@id": "planka:data"
},
"createdAt": {
"@id": "planka:createdAt",
"@type": "xsd:dateTime"
},
"updatedAt": {
"@id": "planka:updatedAt",
"@type": "xsd:dateTime"
},
"Attachment": "planka:Attachment",
"creatorUserId": {
"@id": "planka:creatorUserId",
"@type": "xsd:string"
},
"name": {
"@id": "planka:name",
"@type": "xsd:string"
},
"BackgroundImage": "planka:BackgroundImage",
"projectId": {
"@id": "planka:projectId",
"@type": "xsd:string"
},
"size": {
"@id": "planka:size",
"@type": "xsd:string"
},
"url": {
"@id": "planka:url",
"@type": "@id"
},
"thumbnailUrls": {
"@id": "planka:thumbnailUrls"
},
"BaseCustomFieldGroup": "planka:BaseCustomFieldGroup",
"Board": "planka:Board",
"position": {
"@id": "planka:position",
"@type": "xsd:decimal"
},
"defaultView": {
"@id": "planka:defaultView",
"@type": "xsd:string"
},
"defaultCardType": {
"@id": "planka:defaultCardType",
"@type": "xsd:string"
},
"limitCardTypesToDefaultOne": {
"@id": "planka:limitCardTypesToDefaultOne",
"@type": "xsd:boolean"
},
"alwaysDisplayCardCreator": {
"@id": "planka:alwaysDisplayCardCreator",
"@type": "xsd:boolean"
},
"expandTaskListsByDefault": {
"@id": "planka:expandTaskListsByDefault",
"@type": "xsd:boolean"
},
"BoardMembership": "planka:BoardMembership",
"role": {
"@id": "planka:role",
"@type": "xsd:string"
},
"canComment": {
"@id": "planka:canComment",
"@type": "xsd:boolean"
},
"Card": "planka:Card",
"listId": {
"@id": "planka:listId",
"@type": "xsd:string"
},
"prevListId": {
"@id": "planka:prevListId",
"@type": "xsd:string"
},
"coverAttachmentId": {
"@id": "planka:coverAttachmentId",
"@type": "xsd:string"
},
"description": {
"@id": "planka:description",
"@type": "xsd:string"
},
"dueDate": {
"@id": "planka:dueDate",
"@type": "xsd:dateTime"
},
"isDueCompleted": {
"@id": "planka:isDueCompleted",
"@type": "xsd:boolean"
},
"stopwatch": {
"@id": "planka:stopwatch"
},
"commentsTotal": {
"@id": "planka:commentsTotal",
"@type": "xsd:decimal"
},
"isClosed": {
"@id": "planka:isClosed",
"@type": "xsd:boolean"
},
"listChangedAt": {
"@id": "planka:listChangedAt",
"@type": "xsd:dateTime"
},
"CardLabel": "planka:CardLabel",
"labelId": {
"@id": "planka:labelId",
"@type": "xsd:string"
},
"CardMembership": "planka:CardMembership",
"Comment": "planka:Comment",
"text": {
"@id": "planka:text",
"@type": "xsd:string"
},
"Config": "planka:Config",
"smtpHost": {
"@id": "planka:smtpHost",
"@type": "xsd:string"
},
"smtpPort": {
"@id": "planka:smtpPort",
"@type": "xsd:decimal"
},
"smtpName": {
"@id": "planka:smtpName",
"@type": "xsd:string"
},
"smtpSecure": {
"@id": "planka:smtpSecure",
"@type": "xsd:boolean"
},
"smtpTlsRejectUnauthorized": {
"@id": "planka:smtpTlsRejectUnauthorized",
"@type": "xsd:boolean"
},
"smtpUser": {
"@id": "planka:smtpUser",
"@type": "xsd:string"
},
"smtpPassword": {
"@id": "planka:smtpPassword",
"@type": "xsd:string"
},
"smtpFrom": {
"@id": "planka:smtpFrom",
"@type": "xsd:string"
},
"CustomField": "planka:CustomField",
"baseCustomFieldGroupId": {
"@id": "planka:baseCustomFieldGroupId",
"@type": "xsd:string"
},
"customFieldGroupId": {
"@id": "planka:customFieldGroupId",
"@type": "xsd:string"
},
"showOnFrontOfCard": {
"@id": "planka:showOnFrontOfCard",
"@type": "xsd:boolean"
},
"CustomFieldGroup": "planka:CustomFieldGroup",
"CustomFieldValue": "planka:CustomFieldValue",
"customFieldId": {
"@id": "planka:customFieldId",
"@type": "xsd:string"
},
"content": {
"@id": "planka:content",
"@type": "xsd:string"
},
"Label": "planka:Label",
"color": {
"@id": "planka:color",
"@type": "xsd:string"
},
"List": "planka:List",
"Notification": "planka:Notification",
"commentId": {
"@id": "planka:commentId",
"@type": "xsd:string"
},
"actionId": {
"@id": "planka:actionId",
"@type": "xsd:string"
},
"isRead": {
"@id": "planka:isRead",
"@type": "xsd:boolean"
},
"NotificationService": "planka:NotificationService",
"format": {
"@id": "planka:format",
"@type": "xsd:string"
},
"Project": "planka:Project",
"ownerProjectManagerId": {
"@id": "planka:ownerProjectManagerId",
"@type": "xsd:string"
},
"backgroundImageId": {
"@id": "planka:backgroundImageId",
"@type": "xsd:string"
},
"backgroundType": {
"@id": "planka:backgroundType",
"@type": "xsd:string"
},
"backgroundGradient": {
"@id": "planka:backgroundGradient",
"@type": "xsd:string"
},
"isHidden": {
"@id": "planka:isHidden",
"@type": "xsd:boolean"
},
"ProjectManager": "planka:ProjectManager",
"Task": "planka:Task",
"taskListId": {
"@id": "planka:taskListId",
"@type": "xsd:string"
},
"linkedCardId": {
"@id": "planka:linkedCardId",
"@type": "xsd:string"
},
"assigneeUserId": {
"@id": "planka:assigneeUserId",
"@type": "xsd:string"
},
"isCompleted": {
"@id": "planka:isCompleted",
"@type": "xsd:boolean"
},
"TaskList": "planka:TaskList",
"hideCompletedTasks": {
"@id": "planka:hideCompletedTasks",
"@type": "xsd:boolean"
},
"User": "planka:User",
"email": {
"@id": "planka:email",
"@type": "xsd:string"
},
"username": {
"@id": "planka:username",
"@type": "xsd:string"
},
"avatar": {
"@id": "planka:avatar"
},
"gravatarUrl": {
"@id": "planka:gravatarUrl",
"@type": "@id"
},
"phone": {
"@id": "planka:phone",
"@type": "xsd:string"
},
"organization": {
"@id": "planka:organization",
"@type": "xsd:string"
},
"language": {
"@id": "planka:language",
"@type": "xsd:string"
},
"apiKeyPrefix": {
"@id": "planka:apiKeyPrefix",
"@type": "xsd:string"
},
"subscribeToOwnCards": {
"@id": "planka:subscribeToOwnCards",
"@type": "xsd:boolean"
},
"subscribeToCardWhenCommenting": {
"@id": "planka:subscribeToCardWhenCommenting",
"@type": "xsd:boolean"
},
"turnOffRecentCardHighlighting": {
"@id": "planka:turnOffRecentCardHighlighting",
"@type": "xsd:boolean"
},
"enableFavoritesByDefault": {
"@id": "planka:enableFavoritesByDefault",
"@type": "xsd:boolean"
},
"defaultEditorMode": {
"@id": "planka:defaultEditorMode",
"@type": "xsd:string"
},
"defaultHomeView": {
"@id": "planka:defaultHomeView",
"@type": "xsd:string"
},
"defaultProjectsOrder": {
"@id": "planka:defaultProjectsOrder",
"@type": "xsd:string"
},
"isSsoUser": {
"@id": "planka:isSsoUser",
"@type": "xsd:boolean"
},
"isDeactivated": {
"@id": "planka:isDeactivated",
"@type": "xsd:boolean"
},
"isDefaultAdmin": {
"@id": "planka:isDefaultAdmin",
"@type": "xsd:boolean"
},
"lockedFieldNames": {
"@id": "planka:lockedFieldNames",
"@container": "@list"
},
"Webhook": "planka:Webhook",
"accessToken": {
"@id": "planka:accessToken",
"@type": "xsd:string"
},
"events": {
"@id": "planka:events",
"@container": "@list"
},
"excludedEvents": {
"@id": "planka:excludedEvents",
"@container": "@list"
}
},
"@type": "schema:Dataset",
"schema:name": "PLANKA API JSON-LD context",
"schema:description": "A JSON-LD @context for the objects PLANKA's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-10-27) from openapi/planka-openapi.json.",
"dcterms:created": "2026-10-27",
"dcterms:source": [
"openapi/planka-openapi.json"
]
}