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

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

Required Parameters

Card Id
string
The id of the card
Comment
string

Returns

Create a new board

This operation is used to create a new LeanKit board.

Required Parameters

Title
string

Optional Parameters

Description
string

Returns

Create a new card

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

Required Parameters

Board Id
string
Pick a board.
Type
string
Pick a card type.
Title
string

Optional Parameters

Description
string
Lane Id
string
Pick a card lane.
Priority
string
Pick a card priority.
Size
integer
Tags
string
Comma seperated list of tags.
Planned Start Date
string
YYYY-MM-DD
Planned Finish Date
string
YYYY-MM-DD
Card Id
string
Is Blocked
boolean
True if the card is blocked.
Block Reason
string
External Link Label
string
External Link URL
string
Assignees
string

Returns

Delete a card

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

Required Parameters

Card Id
string
The id of the card

Returns

Get a card

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

Required Parameters

Card Id
string
The id of the card

Returns

Update a card

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

Optional Parameters

Type
string
Pick the card type.
Title
string
Description
string
Lane Id
string
Pick a card lane.
Priority
string
Pick a card priority.
Size
integer
Tags
string
Comma-seperated list of tags.
Planned Start Date-Time
string
YYYY-MM-DD
Planned Finish Date-Time
string
YYYY-MM-DD
Card Id
string
Is Blocked
boolean
True if the card is blocked.
Block Reason
string
External Link Label
string
The label of the external link.
External Link URL
string
The URL of the external link.
Assignees
string

Returns

Triggers

When a card is updated

Triggers when the details of an existing card are updated.

Required Parameters

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

Returns

When a new card is added

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

Required Parameters

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

Returns

Definitions

CreateBoardResponse

Board Id
string
Unique identifier of the board.

CreateCardResponse

Card Id
integer
Unique identifier of the card.

AddCommentResponse

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

CardResponse

Archived Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Blocked Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Card Id
string
Id of the Card.
Class Type
string
Lane's class type.
Created Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Description
string
Lane description.
Description
string
Card's description.
Finish Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Id
string
Board id.
Id
string
Lane id.
Is Blocked
boolean
True if the card is blocked.
Moved Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Planned Finish Date
string
yyyy-MM-dd
Planned Start Date
string
yyyy-MM-dd
Priority
string
Priority of task on card.
Reason
string
Reason the card is blocked.
Size
integer
Card size.
Start Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Title
string
Board title.
Title
string
Card title.
Title
string
Lane title.
Type
string
Lane type.
Type
string
Card type.
Updated Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Value
string
Card's custom id value.
Version
string
Board version.
Version
string
Card version.