Help & Support
Follow

Application API (v1): Get a Board

This method retrieves information about a single board, including all of the Board attributes, the Lanes within the Board and all the Cards within those lanes. It includes all the cards in the Backlog, but does not include the cards within the Archive. Cards within the Archive can be retrieved using the Archive API.

Request URL (GET)

https://{accountname}.leankit.com/kanban/api/boards/{boardId}

Sample request

https://myaccount.leankit.com/kanban/api/boards/101000

Response

{
  "ReplyData": [
    {
      "ParentCards": [],
      "Id": 101000,
      "Title": "Simple Test Board",
      "Description": "Example of a simple test board.",
      "Version": 1131,
      "Active": false,
      "OrganizationId": 1,
      "OrganizationActivities": [],
      "Lanes": [
        {
          "Id": 101107,
          "Description": "",
          "Index": 0,
          "Active": true,
          "Title": "Ready",
          "CardLimit": 0,
          "ClassType": 0,
          "Type": 1,
          "ActivityId": null,
          "ActivityName": "",
          "CardContextId": 0,
          "Width": 2,
          "ParentLaneId": 0,
          "Cards": [
            {
              "SystemType": "Card",
              "Id": 101614,
              "LaneId": 101107,
              "Title": "Sample Card 1",
              "Description": "",
              "Type": {  "Id": 101306 },
              "TypeId": 101306,
              "Priority": 1,
              "PriorityText": "Normal",
              "TypeName": "Task",
              "TypeIconPath": "../../Content/Images/Icons/Library/help.png",
              "TypeColorHex": "#f5f2bc",
              "Size": 0,
              "Active": false,
              "Color": "#f5f2bc",
              "Version": 170,
              "AssignedUsers": [
                {
                  "Id": 16013517,
                  "GravatarLink": "2fa4c5a8f58816f7a793d6252570001a?s=25",
                  "SmallGravatarLink": "2fa4c5a8f58816f7a793d6252570001a?s=17",
                  "FullName": "John Doe",
                  "EmailAddress": "john.doe@leankit.com",
                  "HasGravatar": false,
                  "AssignedUserName": "John Doe",
                  "AssignedUserId": 16013517
                }
              ],
              "CardContexts": [
                {
                  "TaskBoardId": 87378951,
                  "Id": 87385321,
                  "Name": "Tasks",
                  "ProgressPercentage": 0,
                  "TotalCards": 1,
                  "TotalSize": 1,
                  "CompletedCardCount": 0,
                  "CompletedCardSize": 0
                }
              ],
              "IsBlocked": false,
              "BlockReason": "",
              "BlockStateChangeDate": "",
              "Index": 3,
              "DueDate": "",
              "StartDate": "",
              "ExternalSystemName": "",
              "ExternalSystemUrl": "",
              "ExternalCardID": "3",
              "Tags": "",
              "CountOfOldCards": 0,
              "LastMove": "02/28/2014 03:07:10 PM",
              "LastActivity": "02/28/2014 03:07:10 PM",
              "DateArchived": null,
              "LastComment": "",
              "CommentsCount": 0,
              "LastAttachment": "",
              "AttachmentsCount": 0,
              "ClassOfServiceId": 0,
              "ClassOfServiceTitle": "",
              "ClassOfServiceIconPath": "",
              "ClassOfServiceColorHex": "",
              "AssignedUserName": "Jim Bo",
              "AssignedUserId": 16013517,
              "AssignedUserIds": [ 16013517 ],
              "GravatarLink": "2fa4c5a8f58816f7a793d6252570001a?s=25",
              "SmallGravatarLink": "2fa4c5a8f58816f7a793d6252570001a?s=17",
              "DrillThroughBoardId": null,
              "DrillThroughCompletionPercent": 0,
              "DrillThroughProgressComplete": null,
              "DrillThroughProgressTotal": null,
              "DrillThroughProgressSizeComplete": null,
              "DrillThroughProgressSizeTotal": null,
              "HasDrillThroughBoard": false,
              "CurrentTaskBoardId": 87378951,
              "TaskBoardCompletionPercent": 0,
              "TaskBoardCompletedCardCount": 0,
              "TaskBoardCompletedCardSize": 0,
              "TaskBoardTotalCards": 1,
              "TaskBoardTotalSize": 1,
              "CurrentContext": "Tasks",
              "ParentCardId": null
            }
          ],
          "Orientation": 0,
          "TaskBoardId": null,
          "ChildLaneIds": [],
          "SiblingLaneIds": [ 16465110 ],
          "IsDrillthroughDoneLane": false,
          "IsDefaultDropLane": false,
          "LaneState": "lane"
        },
        {
          "Id": 16465110,
          "Description": "",
          "Index": 0,
          "Active": true,
          "Title": "In Process",
          "CardLimit": 2,
          "ClassType": 0,
          "Type": 99,
          "ActivityId": null,
          "ActivityName": "",
          "CardContextId": 0,
          "Width": 1,
          "ParentLaneId": 101103,
          "Cards": [ ],
          "Orientation": 0,
          "TaskBoardId": null,
          "ChildLaneIds": [],
          "SiblingLaneIds": [
              16465110
          ],
          "IsDrillthroughDoneLane": false,
          "IsDefaultDropLane": false,
          "LaneState": "child"
        }
      ],
      "BoardUsers": [
        {
          "Id": 62984826,
          "FullName": "Demo User",
          "UserName": "demouser@leankit.com",
          "Role": 4,
          "WIP": 0,
          "Enabled": true,
          "IsAccountOwner": true,
          "IsDeleted": false,
          "GravatarFeed": "demouser@leankit.com",
          "GravatarLink": "3ab1249be442027903e1180025340b3f",
          "EmailAddress": "demouser@leankit.com",
          "DateFormat": "MM/dd/yyyy",
          "Settings": null,
          "RoleName": "Administrator"
        },
        {
          "Id": 86273264,
          "FullName": "John Doe",
          "UserName": "john.doe@leankit.com",
          "Role": 2,
          "WIP": 0,
          "Enabled": true,
          "IsAccountOwner": false,
          "IsDeleted": false,
          "GravatarFeed": "john.doe@leankit.com",
          "GravatarLink": "2fa4c5a8f58816f7a793d6252570001a",
          "EmailAddress": "john.doe@leankit.com",
          "DateFormat": "MM/dd/yyyy",
          "Settings": null,
          "RoleName": "User"
        }
      ],
      "Backlog": [
        {
          "Id": 101101,
          "Description": "",
          "Index": 0,
          "Active": true,
          "Title": "Backlog",
          "CardLimit": 0,
          "ClassType": 1,
          "Type": 1,
          "ActivityId": null,
          "ActivityName": "",
          "CardContextId": 0,
          "Width": 7,
          "ParentLaneId": 0,
          "Cards": [],
          "Orientation": 0,
          "TaskBoardId": null,
          "ChildLaneIds": [],
          "SiblingLaneIds": [ 16465110 ],
          "IsDrillthroughDoneLane": false,
          "IsDefaultDropLane": false,
          "LaneState": "lane"
        }
      ],
      "Archive": [
        {
          "Id": 101102,
          "Description": "",
          "Index": 0,
          "Active": true,
          "Title": "Archive",
          "CardLimit": 0,
          "ClassType": 2,
          "Type": 1,
          "ActivityId": null,
          "ActivityName": "",
          "CardContextId": 0,
          "Width": 7,
          "ParentLaneId": 0,
          "Cards": [],
          "Orientation": 0,
          "TaskBoardId": null,
          "ChildLaneIds": [],
          "SiblingLaneIds": [ 16465110 ],
          "IsDrillthroughDoneLane": false,
          "IsDefaultDropLane": false,
          "LaneState": "lane"
        }
      ],
      "ClassesOfService": [
        {
          "Id": 63454607,
          "Title": "Date Dependent",
          "Policy": "",
          "IconPath": "../../Content/Images/Icons/Library/calculator.png",
          "ColorHex": "#C4A17A",
          "UseColor": false
        },
        {
          "Id": 63454608,
          "Title": "Expedite",
          "Policy": "",
          "IconPath": "../../Content/Images/Icons/Library/arrow_right.png",
          "ColorHex": "#EDEC46",
          "UseColor": false
        },
        {
          "Id": 63454609,
          "Title": "Regulatory",
          "Policy": "",
          "IconPath": "../../Content/Images/Icons/Library/check.png",
          "ColorHex": "#A8CCDB",
          "UseColor": false
        },
        {
          "Id": 63454610,
          "Title": "Standard",
          "Policy": "",
          "IconPath": "../../Content/Images/Icons/Library/blank.gif",
          "ColorHex": "#F6F6A3",
          "UseColor": false
        },
        {
          "Id": 70953954,
          "Title": "Bug",
          "Policy": "",
          "IconPath": "../../Content/Images/Icons/Library/bug.png",
          "ColorHex": "#F34D45",
          "UseColor": false
        }
      ],
      "CurrentUserRole": 4,
      "CardTypes": [
        {
          "Id": 63454422,
          "Name": "Deliverable",
          "ColorHex": "#DCC7AF",
          "IsDefault": false,
          "IconPath": "../../Content/Images/Icons/Library/help.png",
          "IsCardType": true,
          "IsTaskType": true,
          "IsDefaultTaskType": false
        },
        {
          "Id": 63454420,
          "Name": "Improvement",
          "ColorHex": "#d3e0e4",
          "IsDefault": false,
          "IconPath": "../../Content/Images/Icons/Library/help.png",
          "IsCardType": true,
          "IsTaskType": true,
          "IsDefaultTaskType": false
        },
        {
          "Id": 63454421,
          "Name": "Issue",
          "ColorHex": "#f69679",
          "IsDefault": false,
          "IconPath": "../../Content/Images/Icons/Library/help.png",
          "IsCardType": true,
          "IsTaskType": true,
          "IsDefaultTaskType": false
        },
        {
          "Id": 63454419,
          "Name": "Project",
          "ColorHex": "#8cc63f",
          "IsDefault": false,
          "IconPath": "../../Content/Images/Icons/Library/help.png",
          "IsCardType": true,
          "IsTaskType": true,
          "IsDefaultTaskType": false
        },
        {
          "Id": 63454418,
          "Name": "Task",
          "ColorHex": "#f5f2bc",
          "IsDefault": true,
          "IconPath": "../../Content/Images/Icons/Library/help.png",
          "IsCardType": true,
          "IsTaskType": true,
          "IsDefaultTaskType": true
        }
      ],
      "ClassOfServiceEnabled": false,
      "CardColorField": "CardType",
      "IsCardIdEnabled": true,
      "IsHeaderEnabled": true,
      "IsPrefixEnabled": false,
      "IsPrefixIncludedInHyperlink": false,
      "Prefix": "",
      "IsHyperlinkEnabled": false,
      "Format": "",
      "AllowMultiUserAssignments": true,
      "ArchiveCardDays": 14,
      "EnableDrillThroughBoards": true,
      "AllowMoveCardsBetweenBoards": true,
      "SubscribeUsersToAssignedCardsByDefault": false,
      "AllowAttachments": true,
      "AllowHorizontalSplitInBoardEdit": true,
      "MaxFileSize": 76800,
      "DisallowedFileExtensions": null,
      "EnableTaskBoards": true,
      "AllowSeparateCardAndTaskTypes": true,
      "AllowAddCardTypes": true,
      "BaseWipOnCardSize": false,
      "ExcludeFromOrgAnalytics": false,
      "ExcludeCompletedAndArchiveViolations": true,
      "IsPrivate": false,
      "IsWelcome": false,
      "IsShared": false,
      "SharedBoardRole": null,
      "CustomBoardMoniker": null,
      "TopLevelLaneIds": [ 101107, 16465110 ],
      "BacklogTopLevelLaneId": 101101,
      "ArchiveTopLevelLaneId": 101102,
      "CardContexts": [
        {
          "Id": 63454479,
          "Name": "Subtask",
          "IsDefault": true,
          "IsMaster": false
        },
        {
          "Id": 87385321,
          "Name": "Tasks",
          "IsDefault": false,
          "IsMaster": true
        }
      ],
      "BoardCreator": null,
      "AvailableTags": "",
      "IsAutoIncrementCardIdEnabled": false,
      "IsExternalUrlEnabled": true,
      "IsPermalinkEnabled": false
    }
  ],
  "ReplyCode": 200,
  "ReplyText": "Board successfully retrieved."
}

 

 

 

 

 

 

Doc ID: 1191979654

Have more questions? Submit a request