Help & Support
Follow

LeanKit API (v1): Get a Card by External ID

When the ExternalCardId field is enabled for your board, you can use this API call to look up a card by the external Id. If you are using a predefined prefix in your ExternalCardId field settings you can either use the prefix or not with this API call. If any card is found that matches the {externalCardId} passed in the url either with or without the prefix, the details for that card will be retrieved.  Because LeanKit can now support duplicate External Card Ids, this method returns an array of matching Cards.  If "Allow Duplicate Cards" is not enabled for the Board, the array will only return one Card in the array.

Request URL (GET):

https://{accountname}.leankit.com/kanban/api/board/{boardId}/GetCardByExternalId/{externalCardId}

Request Examples:

https://myaccount.leankit.com/kanban/api/board/101000/GetCardByExternalId/101622
https://myaccount.leankit.com/kanban/api/board/101000/GetCardByExternalId/AZ-1023

Example Response:

{
  "ReplyData": [
    [
      {
        "LaneId": 256392766,
        "Title": "Sample Card 1",
        "Description": null,
        "CreatedOn": "10/14/2015",
        "TypeName": "New Feature",
        "TypeId": 256291536,
        "Priority": 1,
        "Size": 0,
        "Active": false,
        "Color": null,
        "Version": 3,
        "IsBlocked": false,
        "BlockReason": null,
        "TaggedUsers": null,
        "BlockStateChangeDate": null,
        "Index": 0,
        "Statistics": null,
        "StartDate": null,
        "DueDate": null,
        "UserWipOverrideComment": null,
        "ExternalSystemName": null,
        "ExternalSystemUrl": null,
        "ExternalCardIdPrefix": null,
        "Tags": null,
        "ExternalCardID": "AZ-1023",
        "LastMove": "10/14/2015 01:34:30 PM",
        "LastActivity": "10/14/2015 01:34:49 PM",
        "DateArchived": null,
        "CommentsCount": 0,
        "LastComment": null,
        "AttachmentsCount": 0,
        "LastAttachment": null,
        "CopiedFromCardId": 0,
        "IsOlderThanXDays": false,
        "AssignedUserIds": [],
        "AssignedUserId": 0,
        "Id": 256395058,
        "DrillThroughBoardId": null,
        "HasDrillThroughBoard": false,
        "DrillThroughStatistics": null,
        "DrillThroughCompletionPercent": null,
        "DrillThroughProgressTotal": null,
        "DrillThroughProgressComplete": null,
        "DrillThroughProgressSizeComplete": null,
        "DrillThroughProgressSizeTotal": null,
        "ClassOfServiceId": null,
        "ClassOfServiceTitle": null,
        "ClassOfServiceIconPath": null,
        "ClassOfServiceColorHex": null,
        "ClassOfServiceCustomIconName": null,
        "ClassOfServiceCustomIconColor": null,
        "CardTypeIconColor": null,
        "CardTypeIconName": null,
        "CurrentTaskBoardId": null,
        "TaskBoardCompletionPercent": null,
        "TaskBoardCompletedCardCount": 0,
        "TaskBoardCompletedCardSize": 0,
        "TaskBoardTotalCards": null,
        "TaskBoardTotalSize": null,
        "CurrentContext": null,
        "ParentCardId": null
      }
    ]
  ],
  "ReplyCode": 200,
  "ReplyText": "Card successfully retrieved."
}

 

 

 

 

 

 

Doc ID: 1191979657

Have more questions? Submit a request