Connectors Reference

LeanKit

Helping teams work together to deliver customer value, faster.

 

Status: Preview

Tier: Premium

Version: 1.0.0

 

Actions:

Name

Summary

ListBoards ()

List boards

CreateBoard (CreateBoardRequest body)

Create a new board

ListCards (string board)

List cards

CreateCard (CreateCardRequest body)

Create a new card

GetBoard (string boardId)

Get board

GetCard (string cardId)

Get a card

UpdateCard (string cardId, UpdateCardRequest body)

Update a card

DeleteCard (string cardId)

Delete a card

AddComment (string cardId, AddCommentRequest body)

Add comment to a card

GetCurrentUser ()

Current user info.

 

Triggers:

Name

Summary

TrigNewCard (string board, string lane)

When a new card is added

TrigUpdateCard (string board, string lane)

When a card is updated

 

Objects:

Name

Summary

AddCommentRequest

 

AddCommentResponse

 

CardResponse

 

CreateBoardRequest

 

CreateBoardResponse

 

CreateCardRequest

 

CreateCardResponse

 

GetBoardResponse

 

ListBoardsResponse

 

ListCardsResponse

 

UpdateCardRequest

 

 

Actions:

ListBoards

Summary: List boards

Description: List boards

 

Syntax:

LeanKit.ListBoards ()

 

Returns:

          Type:ListBoardsResponse

 

CreateBoard

Summary: Create a new board

Description: This operation is used to create a new LeanKit board.

 

Syntax:

LeanKit.CreateBoard (CreateBoardRequest body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateBoardRequest

 

 

True

 

Returns:

          Type:CreateBoardResponse

 

ListCards

Summary: List cards

Description: List cards

 

Syntax:

LeanKit.ListCards (string board)

 

Parameters:

Name

Type

Summary

Required

Related Action

board

string

(Board Id)

Pick a board.

True

ListBoards

 

Returns:

          Type:ListCardsResponse

 

CreateCard

Summary: Create a new card

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

 

Syntax:

LeanKit.CreateCard (CreateCardRequest body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateCardRequest

 

 

True

 

Returns:

          Type:CreateCardResponse

 

GetBoard

Summary: Get board

Description: This operation is used to retrieve all information about a board in LeanKit.

 

Syntax:

LeanKit.GetBoard (string boardId)

 

Parameters:

Name

Type

Summary

Required

Related Action

boardId

string

(Board Id)

Pick a board.

True

ListBoards

 

Returns:

          Type:GetBoardResponse

 

GetCard

Summary: Get a card

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

 

Syntax:

LeanKit.GetCard (string cardId)

 

Parameters:

Name

Type

Summary

Required

Related Action

cardId

string

(Card Id)

The id of the card

True

 

Returns:

          Type:CardResponse

 

UpdateCard

Summary: Update a card

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

 

Syntax:

LeanKit.UpdateCard (string cardId, UpdateCardRequest body)

 

Parameters:

Name

Type

Summary

Required

Related Action

cardId

string

(Card Id)

The id of the card

True

body

UpdateCardRequest

 

 

True

 

Returns:

          Type:CardResponse

 

DeleteCard

Summary: Delete a card

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

 

Syntax:

LeanKit.DeleteCard (string cardId)

 

Parameters:

Name

Type

Summary

Required

Related Action

cardId

string

(Card Id)

The id of the card

True

 

Returns:

          Type:CardResponse

 

AddComment

Summary: Add comment to a card

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

 

Syntax:

LeanKit.AddComment (string cardId, AddCommentRequest body)

 

Parameters:

Name

Type

Summary

Required

Related Action

cardId

string

(Card Id)

The id of the card

True

body

AddCommentRequest

 

 

True

 

Returns:

          Type:AddCommentResponse

 

GetCurrentUser

Summary: Current user info.

Description: Returns information about current user.

 

Syntax:

LeanKit.GetCurrentUser ()

 

Returns:

 

Triggers:

Trigger TrigNewCard

Summary: When a new card is added

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

 

Syntax:

LeanKit.TrigNewCard (string board, string lane)

 

Parameters:

Name

Type

Summary

Required

Related Action

board

string

(Board Id)

Pick a board.

True

ListBoards

lane

string

(Lane Id)

Pick a lane.

True

GetBoard

 

Returns:

          Type:array of (CardResponse)

 

Trigger TrigUpdateCard

Summary: When a card is updated

Description: Triggers when the details of an existing card are updated.

 

Syntax:

LeanKit.TrigUpdateCard (string board, string lane)

 

Parameters:

Name

Type

Summary

Required

Related Action

board

string

(Board Id)

Pick a board.

True

ListBoards

lane

string

(Lane Id)

Pick a lane.

True

GetBoard

 

Returns:

          Type:array of (CardResponse)

 


 

AddCommentRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

text

string

Comment

 


 

AddCommentResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

Comment id.

createdOn

string(date-time)

Created Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

createdBy

CreatedBy

Author

Details of comment author.

text

string

Comment

Body of the comment.

 

CreatedBy

Summary: Author

Description: Details of comment author.

 

          Properties:

Name

Type

Summary

id

string

Id

Comment author's user id.

emailAddress

string

Email

Email address of the comment author.

fullName

string

Name

Full name of the comment author.

 


 

CardResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

actualFinish

string(date-time)

Finish Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

actualStart

string(date-time)

Start Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

blockedStatus

BlockedStatus

Blocked

Blocked status details.

board

Board

Board

Board details.

createdOn

string(date-time)

Created Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

archivedOn

string(date-time)

Archived Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

description

string

Description

Card's description.

plannedFinish

string

Planned Finish Date

yyyy-MM-dd

customId

CustomId

Custom Id

Card's custom id.

id

string

Card Id

Id of the Card.

lane

Lane

Lane

Details of the lane.

updatedOn

string(date-time)

Updated Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

movedOn

string(date-time)

Moved Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

priority

string

Priority

Priority of task on card.

size

integer(int32)

Size

Card size.

plannedStart

string

Planned Start Date

yyyy-MM-dd

title

string

Title

Card title.

version

string

Version

Card version.

type

Type

Type

Details about the type of card.

 

BlockedStatus

Summary: Blocked

Description: Blocked status details.

 

          Properties:

Name

Type

Summary

isBlocked

boolean

Is Blocked

True if the card is blocked.

reason

string

Reason

Reason the card is blocked.

date

string(date-time)

Blocked Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ

 

Board

Summary: Board

Description: Board details.

 

          Properties:

Name

Type

Summary

id

string

Id

Board id.

title

string

Title

Board title.

version

string

Version

Board version.

 

CustomId

Summary: Custom Id

Description: Card's custom id.

 

          Properties:

Name

Type

Summary

value

string

Value

Card's custom id value.

 

Lane

Summary: Lane

Description: Details of the lane.

 

          Properties:

Name

Type

Summary

description

string

Description

Lane description.

id

string

Id

Lane id.

laneClassType

string

Class Type

Lane's class type.

laneType

string

Type

Lane type.

title

string

Title

Lane title.

 

Type

Summary: Type

Description: Details about the type of card.

 

          Properties:

Name

Type

Summary

title

string

Type

Card type.

 


 

CreateBoardRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

title

string

Title

 

description

string

Description

 


 

CreateBoardResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Board Id

Unique identifier of the board.


 

CreateCardRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

boardId

string

Board Id

Pick a board.

typeId

string

Type

Pick a card type.

title

string

Title

 

description

string

Description

 

laneId

string

Lane Id

Pick a card lane.

priority

string

Priority

Pick a card priority.

size

integer(int32)

Size

 

tags

string

Tags

Comma seperated list of tags.

plannedStart

string

Planned Start Date

YYYY-MM-DD

plannedFinish

string

Planned Finish Date

YYYY-MM-DD

customId

string

Card Id

 

isBlocked

boolean

Is Blocked

True if the card is blocked.

blockReason

string

Block Reason

 

externalLink

ExternalLink

 

 

assignedUserIds

array of (string)

Assignees

Array of user Ids (numbers).

 

ExternalLink

Summary:

Description:

 

          Properties:

Name

Type

Summary

label

string

External Link Label

 

url

string

External Link URL

 

 


 

CreateCardResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Card Id

Unique identifier of the card.


 

GetBoardResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

cardTypes

array of (CardTypesItem)

Card Type

Type of card.

lanes

array of (LanesItem)

Lanes

Board lanes.

priorities

array of (PrioritiesItem)

Priorities

Board priorities.

 

CardTypesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Type

Card type.

 

LanesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

Lane id.

name

string

Name

Lane name.

 

PrioritiesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

Priority name.

 


 

ListBoardsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

boards

array of (BoardsItem)

Boards

Boards array.

 

BoardsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

Board id.

title

string

Title

Board title.

 


 

ListCardsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

cards

array of (CardResponse)

cards

cards


 

UpdateCardRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

typeId

string

Type

Pick the card type.

title

string

Title

 

description

string

Description

 

laneId

string

Lane Id

Pick a card lane.

priority

string

Priority

Pick a card priority.

size

integer(int32)

Size

 

tags

string

Tags

Comma-seperated list of tags.

plannedStart

string

Planned Start Date-Time

YYYY-MM-DD

plannedFinish

string

Planned Finish Date-Time

YYYY-MM-DD

customId

string

Card Id

 

isBlocked

boolean

Is Blocked

True if the card is blocked.

blockReason

string

Block Reason

 

externalLink

ExternalLink

 

 

assignedUserIds

array of (string)

Assignees

Array of user Ids (numbers).

 

ExternalLink

Summary:

Description:

 

          Properties:

Name

Type

Summary

label

string

External Link Label

The label of the external link.

url

string

External Link URL

The URL of the external link.