LeanKit (Preview)

LeanKit (Preview)

Helping teams work together to deliver customer value, faster.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds
Frequency of trigger polls 1 120 seconds

Creating a connection

To connect your account, you will need the following information:

Username
string
The username for this api
Password
securestring
The password for this api
Site url
string
Root site url (Example: https://my.leankit.com )

Actions

Add comment to a card

Operation ID:
AddComment

This operation is used to add a comment to an existing card in LeanKit.

Required Parameters

Card Id
string
The id of the card
Key:
cardId
Comment
string
Key:
text

Returns

Body
AddCommentResponse

Create a new board

Operation ID:
CreateBoard

This operation is used to create a new LeanKit board.

Required Parameters

Title
string
Key:
title

Optional Parameters

Description
string
Key:
description

Returns

Body
CreateBoardResponse

Create a new card

Operation ID:
CreateCard

This operation is used to create a new card in LeanKit.

Required Parameters

Board Id
string
Pick a board.
Key:
boardId
Type
string
Pick a card type.
Key:
typeId
Title
string
Key:
title

Optional Parameters

Description
string
Key:
description
Lane Id
string
Pick a card lane.
Key:
laneId
Priority
string
Pick a card priority.
Key:
priority
Size
integer
Key:
size
Tags
string
Comma seperated list of tags.
Key:
tags
Planned Start Date
string
YYYY-MM-DD
Key:
plannedStart
Planned Finish Date
string
YYYY-MM-DD
Key:
plannedFinish
Card Id
string
Key:
customId
Is Blocked
boolean
True if the card is blocked.
Key:
isBlocked
Block Reason
string
Key:
blockReason
External Link Label
string
Key:
label
External Link URL
string
Key:
url
Assignees
string
Key:
Assignees

Returns

Body
CreateCardResponse

Delete a card

Operation ID:
DeleteCard

This operation is used to delete an existing card in LeaKit.

Required Parameters

Card Id
string
The id of the card
Key:
cardId

Returns

Body
CardResponse

Get a card

Operation ID:
GetCard

This operation is used to retrieve all information about a card, given its id.

Required Parameters

Card Id
string
The id of the card
Key:
cardId

Returns

Body
CardResponse

Update a card

Operation ID:
UpdateCard

This operation is used to update the details of an existing card given its id.

Required Parameters

Card Id
string
The id of the card
Key:
cardId

Optional Parameters

Type
string
Pick the card type.
Key:
typeId
Title
string
Key:
title
Description
string
Key:
description
Lane Id
string
Pick a card lane.
Key:
laneId
Priority
string
Pick a card priority.
Key:
priority
Size
integer
Key:
size
Tags
string
Comma-seperated list of tags.
Key:
tags
Planned Start Date-Time
string
YYYY-MM-DD
Key:
plannedStart
Planned Finish Date-Time
string
YYYY-MM-DD
Key:
plannedFinish
Card Id
string
Key:
customId
Is Blocked
boolean
True if the card is blocked.
Key:
isBlocked
Block Reason
string
Key:
blockReason
External Link Label
string
The label of the external link.
Key:
label
External Link URL
string
The URL of the external link.
Key:
url
Assignees
string
Key:
Assignees

Returns

Body
CardResponse

Triggers

When a card is updated

Operation ID:
TrigUpdateCard

Triggers when the details of an existing card are updated.

Required Parameters

Board Id
string
Pick a board.
Key:
board
Lane Id
string
Pick a lane.
Key:
lane

Returns

Body
CardResponse

When a new card is added

Operation ID:
TrigNewCard

Triggers when a new card is added to the given board and lane.

Required Parameters

Board Id
string
Pick a board.
Key:
board
Lane Id
string
Pick a lane.
Key:
lane

Returns

Body
CardResponse

Definitions

CreateBoardResponse

Board Id
string
Unique identifier of the board.
Path:
id

CreateCardResponse

Card Id
integer
Unique identifier of the card.
Path:
id

AddCommentResponse

Comment
string
Body of the comment.
Path:
text
Created Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Path:
createdOn
Email
string
Email address of the comment author.
Path:
createdBy.emailAddress
Id
string
Comment id.
Path:
id
Id
string
Comment author's user id.
Path:
createdBy.id
Name
string
Full name of the comment author.
Path:
createdBy.fullName

CardResponse

Archived Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Path:
archivedOn
Blocked Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Path:
blockedStatus.date
Card Id
string
Id of the Card.
Path:
id
Class Type
string
Lane's class type.
Path:
lane.laneClassType
Created Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Path:
createdOn
Description
string
Lane description.
Path:
lane.description
Description
string
Card's description.
Path:
description
Finish Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Path:
actualFinish
Id
string
Board id.
Path:
board.id
Id
string
Lane id.
Path:
lane.id
Is Blocked
boolean
True if the card is blocked.
Path:
blockedStatus.isBlocked
Moved Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Path:
movedOn
Planned Finish Date
string
yyyy-MM-dd
Path:
plannedFinish
Planned Start Date
string
yyyy-MM-dd
Path:
plannedStart
Priority
string
Priority of task on card.
Path:
priority
Reason
string
Reason the card is blocked.
Path:
blockedStatus.reason
Size
integer
Card size.
Path:
size
Start Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Path:
actualStart
Title
string
Board title.
Path:
board.title
Title
string
Card title.
Path:
title
Title
string
Lane title.
Path:
lane.title
Type
string
Lane type.
Path:
lane.laneType
Type
string
Card type.
Path:
type.title
Updated Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Path:
updatedOn
Value
string
Card's custom id value.
Path:
customId.value
Version
string
Board version.
Path:
board.version
Version
string
Card version.
Path:
version