Businessmap
Businessmap is the most flexible software platform for outcomes-driven enterprise agility. The unmatched functionality consolidates multiple tools into one, enabling affordable deployment at scale, visibility across all projects/portfolios, and alignment on goals, to deliver quality work faster. The Businessmap connector can be used to reflect changes in external tools (e.g. issue trackers, email, time tracking tools, etc.) inside your Kanban cards.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Businessmap Support |
| URL | https://businessmap.io/customer-support |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | Businessmap |
| Website | https://businessmap.io |
| Privacy policy | https://businessmap.io/privacy-policy |
| Categories | Business Management; Business Intelligence |
Businessmap is the most flexible software platform for outcomes-driven enterprise agility. It helps managers gain visibility across all projects, connects planning with execution, and guides the continuous optimization of the delivery workflows. Built with scale in mind, Businessmap can easily expand from a single delivery team to a strategic portfolio. The unmatched functionality consolidates multiple tools into one, enabling affordable deployment at scale, visibility across all projects/portfolios, and alignment on goals, to deliver quality work faster. Businessmap is the leading Kanban platform for efficient project management and delivery.
This is Businessmap Connector for Power Automate. It works directly with data from Businessmap via our latest API v2. The Businessmap connector can be used to reflect changes in external tools inside your Kanban cards or to read data from Businessmap and use it in third party connectors. Visit integrations section in our knowledge base to get some real examples on how to use the connector.
Prerequisites
- To use this connector, you need a Businessmap account and user with permissions to access the API. Sign-Up here and create and account to try it.
How to get credentials
You can find your API key inside "API" menu in your profile.
Get started with your connector
The connector has one trigger which is general and handles all events. Set this trigger as the first step in your flow when you want to receive events from Businessmap. Your next action should be a "Condition" check, where you will add a filter on "event" and proceed only if the event type matches the one you are interested in. Here you can find a list with all the events and possible values that will fire the trigger. The next step usually will be "Get Card By ID", it will get all the details from the card and you will be able to use and operate on this data in the flow that follows.
Known issues and limitations
Certain limits are applied to ensure the product and our APIs are running as smoothly and efficiently as possible. The exact API limits depend on your service plan. You can read more information about this here
Common errors and remedies
If you encounter a 429 error, it means that you have reached your API limits. The error details tell you how long you have to wait before you are able to send your next request. All other errors have messages which explain the exact reason for the error.
FAQ
We have an extensive Knowledge Base section and if you have any question you can't find the answer to, contact us and we will be glad to help.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
| Subdomain | string | Specify the subdomain of your Businessmap account | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Add Comment |
Add a comment to a card or initiative. |
| Add Comment (deprecated) [DEPRECATED] |
This action has been deprecated. Please use Add Comment instead.
|
| Archive Card (deprecated) [DEPRECATED] |
This action has been deprecated. Please use Archive or Unarchive Card instead.
|
| Archive or Unarchive Card |
Add card to archive, or extract it from archive. |
| Block Card |
Block a card. |
| Block or Unblock Card (deprecated) [DEPRECATED] |
(Deprecated) Block, unblock or edit block reasons for a card. |
| Create Card |
Create a card in a board of your choice. To set custom fields, stickers and tags use in combination with "Update Card". |
| Create Card (deprecated) [DEPRECATED] |
This action has been deprecated. Please use Create Card instead.
|
| Create Subtask |
Create a new subtask of a card or initiative. |
| Create Subtask (deprecated) [DEPRECATED] |
This action has been deprecated. Please use Create Subtask instead.
|
| Delete Card (deprecated) [DEPRECATED] |
(Deprecated) Delete a card. |
| Discard or Restore Card |
Discard a card or restore a previously discarded card. |
| Download Attachment |
Download an attachment from a card. File content is returned as base64 encoded string. |
| Get All Cards |
Get all cards from a selected board. The response contains up to 200 cards. For more than 200 cards, please use paging. |
| Get All Cards (deprecated) [DEPRECATED] |
This action has been deprecated. Please use Get All Cards instead.
|
| Get Board Columns (deprecated) [DEPRECATED] |
This action has been deprecated. Please use Get Columns instead.
|
| Get Boards (deprecated) [DEPRECATED] |
This action has been deprecated. Please use Get Boards instead.
|
| Get Card Attachments |
Get a list with all attachments for a specified card. |
| Get Card by Custom ID |
Find card by custom card id. If multiple cards are found, only the first one will be returned. Use ‘Board’ parameter to filter search by boards. |
| Get Card by ID |
Get card details by its internal ID. |
| Get Card By ID (deprecated) [DEPRECATED] |
This action has been deprecated. Please use Get Card by ID instead.
|
| Get Lanes (deprecated) [DEPRECATED] |
This action has been deprecated. Please use Get Lanes instead.
|
| Get Types (deprecated) [DEPRECATED] |
This action has been deprecated. Please use Get Types instead.
|
| Get Workflows (deprecated) [DEPRECATED] |
This action has been deprecated. Please use Get Workflows instead.
|
| Get {Object} Name |
Get the name of an object based on its ID. Helper function used when you want to get the name of the board, workflow, column etc. based on its ID |
| Link Cards |
Link a card to an existing card. |
| Log Time |
Log time to a card. |
| Log Time (number of seconds) (deprecated) [DEPRECATED] |
This action has been deprecated. Please use Log Time instead.
|
| Move Card |
Move a card to new column, lane, workflow or board. |
| Move Card (deprecated) [DEPRECATED] |
This action has been deprecated. Please use Move Card instead.
|
| Set Custom Field Value |
Set the value of a custom field. |
| Set or Unset Stickers |
Add sticker(s) to a card or remove assigned sticker(s) from a card |
| Set or Unset Tags |
Add tag(s) to a card or remove assigned tag(s) from a card |
| Unblock Card |
Unblock a card. |
| Unlink Cards |
Remove a link between two cards. |
| Update Card |
Update the properties of a card (Title, Description, Priority, etc.). If getting a timeout or API limit reached errors, try breaking down the setting of custom fields, stickers and tags into separate actions. |
| Update Card (deprecated) [DEPRECATED] |
This action has been deprecated. Please use Update Card instead.
|
| Upload Attachment |
Upload an attachment to a card. |
Add Comment
Add a comment to a card or initiative.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Card ID
|
card_id | True | integer |
Enter Card ID |
|
Comment
|
text | True | string |
Comment |
Returns
Add Comment (deprecated) [DEPRECATED]
This action has been deprecated. Please use Add Comment instead.
(Deprecated) Adds a comment to a card or initiative.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content Type
|
Content-Type | True | string |
Always use: application/json |
|
Content Type
|
Accept | True | string |
Always use: application/json |
|
Card ID
|
taskid | string |
card id |
|
|
Comment
|
comment | string |
comment |
Returns
Archive Card (deprecated) [DEPRECATED]
This action has been deprecated. Please use Archive or Unarchive Card instead.
(Deprecated) Move card to archive. The card must not be blocked and it must be in column Done or in column Archive.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Card ID
|
cardid | True | string |
card id |
|
Version
|
version | string |
version |
Returns
Archive or Unarchive Card
Add card to archive, or extract it from archive.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Card ID
|
card_id | True | integer |
Enter Card ID |
|
Action
|
is_archived | True | integer |
Select Action |
Returns
Block Card
Block a card.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Board
|
board_id | True | integer |
Board must be selected from dropdown |
|
Card ID
|
card_id | True | integer |
Enter Card ID |
|
Block Reason
|
reason_id | True | string |
Select Block Reason |
|
Comment
|
comment | string |
Add Comment to the Block Reason |
Returns
Block or Unblock Card (deprecated) [DEPRECATED]
(Deprecated) Block, unblock or edit block reasons for a card.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Board ID
|
boardid | True | string |
Select board from the dropdown list |
|
Card ID
|
taskid | True | string |
card id |
|
Event Type
|
event | True | string | |
|
Block Reason
|
blockreason | string |
reason for block |
Returns
Create Card
Create a card in a board of your choice. To set custom fields, stickers and tags use in combination with "Update Card".
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Board
|
board_id | True | integer |
Board must be selected from dropdown |
|
Workflow
|
workflow_id | True | integer |
Workflow must be selected from dropdown |
|
Template
|
template_id | integer |
Select Template |
|
|
Column
|
column_id | True |
Select Column or Enter Column Name or ID as a Custom Value |
|
|
Lane
|
lane_id | True |
Select Lane or Enter Lane Name or ID as a Custom Value |
|
|
Title
|
title | True | string |
Card Title |
|
Description
|
description | string |
Card Description |
|
|
Custom ID
|
custom_id | string |
Custom Card ID |
|
|
Owner
|
owner_user_id | integer |
Select Card Owner |
|
|
Reporter User
|
reporter_user_id | integer |
Select reporter from Businessmap users |
|
|
Reporter Email
|
reporter_email | string |
Enter Reporter email address, only if no user is selected above |
|
|
Type
|
type_id | integer |
Select Card Type |
|
|
Card Size
|
size | double |
Card Size |
|
|
Priority
|
priority | integer |
Select Priority |
|
|
Color
|
color | string |
Color (Hex, e.g. #000000) |
|
|
Deadline
|
deadline | string |
Deadline (Format: YYYY-MM-DD) |
|
|
Planned Start Date
|
planned_start_date | string |
Planned Start Date (Format: YYYY-MM-DD) (Initiatives Only) |
|
|
Planned End Date
|
planned_end_date | string |
Planned End Date (Format: YYYY-MM-DD) (Initiatives Only) |
|
|
Actual Start Time
|
actual_start_time | string |
Actual Start Time (Format: YYYY-MM-DDTHH:mm:ssZ) (Initiatives Only) |
|
|
Actual End Time
|
actual_end_time | string |
Actual End Time (Format: YYYY-MM-DDTHH:mm:ssZ) (Initiatives Only) |
Returns
- Body
- getCardResponse
Create Card (deprecated) [DEPRECATED]
This action has been deprecated. Please use Create Card instead.
(Deprecated) Create a card in a board of your choice.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content Type
|
Content-Type | string |
Always use: application/json |
|
|
Content Type
|
Accept | string |
Always use: application/json |
|
|
Board ID
|
boardid | True | string |
Select board |
|
Title
|
title | string |
title |
|
|
Description
|
description | string |
card details |
|
|
Priority
|
priority | string |
possible values: Low, Average, High, Critical |
|
|
Assignee
|
assignee | string |
username of the assignee |
|
|
Color
|
color | string |
hex color code like this #F37325 |
|
|
Size
|
size | string |
size |
|
|
Tags
|
tags | string |
multiple tags should be separated with space |
|
|
Custom Fields
|
cfields | string |
JSON formatted list of custom fields and their values {"field1":"value1","field2":"value2"} |
|
|
Deadline
|
deadline | string |
deadline date in this format YYYY-MM-DD |
|
|
External Link
|
extlink | string |
external link |
|
|
Type
|
type | string |
the name of the type you want to set |
|
|
Card Template
|
template | string |
the name of the card template you want to apply |
|
|
Column name
|
column | string |
exact column name |
|
|
Lane
|
lane | string |
lane name |
|
|
Position
|
position | string |
card position in the column |
|
|
Exceeding reason
|
exceedingreason | string |
exceeding reason |
Returns
Create Subtask
Create a new subtask of a card or initiative.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Board
|
board_id | True | integer |
Board must be selected from dropdown |
|
Card ID
|
card_id | True | integer |
Enter Card ID |
|
Description
|
description | True | string |
Subtask Description |
|
Owner
|
owner_user_id | string |
Select user |
|
|
Subtask Status
|
is_finished | integer |
Select Subtask Status |
Returns
Create Subtask (deprecated) [DEPRECATED]
This action has been deprecated. Please use Create Subtask instead.
(Deprecated) Creates a new subtask of a card or initiative.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content Type
|
Content-Type | True | string |
Always use: application/json |
|
Content Type
|
Accept | True | string |
Always use: application/json |
|
Parent card ID
|
taskparent | integer |
ID of the parent card |
|
|
Title
|
title | string |
title |
|
|
Assignee
|
assignee | string |
username of the assignee |
Returns
Delete Card (deprecated) [DEPRECATED]
(Deprecated) Delete a card.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Board ID
|
boardid | True | string |
Select board from the dropdown list |
|
Card ID
|
taskid | True | string |
card id |
Returns
Discard or Restore Card
Discard a card or restore a previously discarded card.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Card ID
|
card_id | True | integer |
Enter Card ID |
|
Action
|
is_discarded | True | integer |
Select Action |
Returns
Download Attachment
Download an attachment from a card. File content is returned as base64 encoded string.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Card ID
|
card_id | True | integer |
Enter Card ID |
|
File name
|
attachment_id | True | integer |
Select Attachment or enter Attachment ID from Get Card Attachments |
Returns
Get All Cards
Get all cards from a selected board. The response contains up to 200 cards. For more than 200 cards, please use paging.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Board
|
board_ids | True | integer |
Board must be selected from dropdown |
|
Custom Card IDs
|
custom_ids | array |
Enter Custom Ids |
|
|
Page
|
page | integer |
Page Number |
|
|
State
|
state | string |
The state value of cards that you want to get. By default it's the active state. |
Returns
- Body
- getAllCardsResponse
Get All Cards (deprecated) [DEPRECATED]
This action has been deprecated. Please use Get All Cards instead.
(Deprecated) Get all cards from a given board.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Board ID
|
boardid | True | string |
Select board from the dropdown list |
Returns
Get Board Columns (deprecated) [DEPRECATED]
This action has been deprecated. Please use Get Columns instead.
(Deprecated) Get all columns for a specified board.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Board ID
|
board_id | True | string |
The board to get the columns for. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
data
|
data | array of object |
data |
|
column_id
|
data.column_id | integer |
column_id |
|
workflow
|
data.workflow | integer |
workflow |
|
section
|
data.section | integer |
section |
|
parent_column_id
|
data.parent_column_id | integer |
parent_column_id |
|
position
|
data.position | integer |
position |
|
name
|
data.name | string |
name |
|
description
|
data.description | string |
description |
|
color
|
data.color | string |
color |
|
limit
|
data.limit | integer |
limit |
|
cards_per_row
|
data.cards_per_row | integer |
cards_per_row |
|
flow_type
|
data.flow_type | integer |
flow_type |
Get Boards (deprecated) [DEPRECATED]
This action has been deprecated. Please use Get Boards instead.
(Deprecated) Get all boards from the account.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
data
|
data | array of object |
data |
|
board_id
|
data.board_id | integer |
board_id |
|
workspace_id
|
data.workspace_id | integer |
workspace_id |
|
is_archived
|
data.is_archived | integer |
is_archived |
|
name
|
data.name | string |
name |
Get Card Attachments
Get a list with all attachments for a specified card.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Card ID
|
card_id | True | integer |
Enter Card ID |
Returns
Get Card by Custom ID
Find card by custom card id. If multiple cards are found, only the first one will be returned. Use ‘Board’ parameter to filter search by boards.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Custom Card ID
|
custom_ids | True | string |
Enter Custom Ids |
|
Board
|
board_ids | integer |
Board must be selected from dropdown |
Returns
- Body
- getCardResponse
Get Card by ID
Get card details by its internal ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Card ID
|
card_id | True | integer |
Enter Card ID |
Returns
- Body
- getCardResponse
Get Card By ID (deprecated) [DEPRECATED]
This action has been deprecated. Please use Get Card by ID instead.
(Deprecated) Get card by its ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Board ID
|
boardid | True | string |
Select board from the dropdown list |
|
Card ID
|
taskid | True | string |
card id |
|
Get History
|
history | string |
set to 'yes' if you want to get card history |
|
|
Get comments
|
comments | string |
set to 'yes' if you want to get card comments |
|
|
Text Format
|
textformat | string |
text format returned for the card description |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
taskid
|
taskid | string |
taskid |
|
boardid
|
boardid | string |
boardid |
|
title
|
title | string |
title |
|
description
|
description | string |
description |
|
type
|
type | string |
type |
|
assignee
|
assignee | string |
assignee |
|
subtasks
|
subtasks | string |
subtasks |
|
subtaskscomplete
|
subtaskscomplete | string |
subtaskscomplete |
|
color
|
color | string |
color |
|
priority
|
priority | string |
priority |
|
size
|
size | string |
size |
|
deadline
|
deadline | string |
deadline |
|
deadlineoriginalformat
|
deadlineoriginalformat | string |
deadlineoriginalformat |
|
extlink
|
extlink | string |
extlink |
|
tags
|
tags | string |
tags |
|
leadtime
|
leadtime | integer |
leadtime |
|
blocked
|
blocked | string |
blocked |
|
blockedreason
|
blockedreason | string |
blockedreason |
|
columnname
|
columnname | string |
columnname |
|
lanename
|
lanename | string |
lanename |
|
subtaskdetails
|
subtaskdetails | array of |
subtaskdetails |
|
columnid
|
columnid | string |
columnid |
|
laneid
|
laneid | string |
laneid |
|
position
|
position | string |
position |
|
workflow
|
workflow | integer |
workflow |
|
workflow_id
|
workflow_id | integer |
workflow_id |
|
url
|
attachments.FXPR1VE0LIC9.url | string |
url |
|
clientName
|
attachments.FXPR1VE0LIC9.clientName | string |
clientName |
|
uniqueName
|
attachments.FXPR1VE0LIC9.uniqueName | string |
uniqueName |
|
fileSize
|
attachments.FXPR1VE0LIC9.fileSize | float |
fileSize |
|
fileType
|
attachments.FXPR1VE0LIC9.fileType | string |
fileType |
|
status
|
attachments.FXPR1VE0LIC9.status | string |
status |
|
url
|
attachments.0XC7C1PRR9ZK.url | string |
url |
|
clientName
|
attachments.0XC7C1PRR9ZK.clientName | string |
clientName |
|
uniqueName
|
attachments.0XC7C1PRR9ZK.uniqueName | string |
uniqueName |
|
fileSize
|
attachments.0XC7C1PRR9ZK.fileSize | float |
fileSize |
|
fileType
|
attachments.0XC7C1PRR9ZK.fileType | string |
fileType |
|
status
|
attachments.0XC7C1PRR9ZK.status | string |
status |
|
columnpath
|
columnpath | string |
columnpath |
|
reporter
|
reporter | string |
reporter |
|
customfields
|
customfields | array of object |
customfields |
|
fieldid
|
customfields.fieldid | integer |
fieldid |
|
name
|
customfields.name | string |
name |
|
type
|
customfields.type | string |
type |
|
value
|
customfields.value | string |
value |
|
mandatory
|
customfields.mandatory | boolean |
mandatory |
|
immutable
|
customfields.immutable | boolean |
immutable |
|
updatedat
|
updatedat | string |
updatedat |
|
loggedtime
|
loggedtime | integer |
loggedtime |
|
historydetails
|
historydetails | array of object |
historydetails |
|
eventtype
|
historydetails.eventtype | string |
eventtype |
|
historyevent
|
historydetails.historyevent | string |
historyevent |
|
taskid
|
historydetails.taskid | string |
taskid |
|
details
|
historydetails.details | string |
details |
|
author
|
historydetails.author | string |
author |
|
entrydate
|
historydetails.entrydate | string |
entrydate |
|
historyid
|
historydetails.historyid | string |
historyid |
|
comments
|
comments | array of |
comments |
Get Lanes (deprecated) [DEPRECATED]
This action has been deprecated. Please use Get Lanes instead.
(Deprecated) Gets all lanes for a specified board.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Board ID
|
board_id | True | string |
The board to get the lanes for. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
data
|
data | array of object |
data |
|
lane_id
|
data.lane_id | integer |
lane_id |
|
workflow
|
data.workflow | integer |
workflow |
|
parent_lane_id
|
data.parent_lane_id | integer |
parent_lane_id |
|
position
|
data.position | integer |
position |
|
name
|
data.name | string |
name |
|
description
|
data.description | string |
description |
|
color
|
data.color | string |
color |
Get Types (deprecated) [DEPRECATED]
This action has been deprecated. Please use Get Types instead.
(Deprecated) Gets all types within the account.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
data
|
data | array of object |
data |
|
type_id
|
data.type_id | integer |
type_id |
|
icon_type
|
data.icon_type | integer |
icon_type |
|
icon_id
|
data.icon_id | integer |
icon_id |
|
name
|
data.name | string |
name |
|
description
|
data.description | string |
description |
|
color
|
data.color | string |
color |
|
card_color_sync
|
data.card_color_sync | integer |
card_color_sync |
|
all_properties_are_locked
|
data.all_properties_are_locked | integer |
all_properties_are_locked |
|
availability
|
data.availability | integer |
availability |
|
is_enabled
|
data.is_enabled | integer |
is_enabled |
Get Workflows (deprecated) [DEPRECATED]
This action has been deprecated. Please use Get Workflows instead.
(Deprecated) Get all workflows from a given board.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Board ID
|
board_id | True | string |
Board |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
data
|
data | array of object |
data |
|
type
|
data.type | integer |
type |
|
position
|
data.position | integer |
position |
|
is_enabled
|
data.is_enabled | integer |
is_enabled |
|
is_collapsible
|
data.is_collapsible | integer |
is_collapsible |
|
name
|
data.name | string |
name |
|
workflow_id
|
data.workflow_id | integer |
workflow_id |
Get {Object} Name
Get the name of an object based on its ID. Helper function used when you want to get the name of the board, workflow, column etc. based on its ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Board
|
board_id | True | integer |
Board must be selected from dropdown |
|
Item
|
item | True | string |
Select Object Type |
|
ID
|
id | True | integer |
Enter Object ID |
Returns
Link Cards
Link a card to an existing card.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Card ID
|
card_id | True | integer |
Enter Card ID |
|
Will be linked as
|
link_type | True | string |
Select Link Type |
|
To card id
|
linked_card_id | True | integer |
Card id to link to current card |
Returns
Log Time
Log time to a card.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Card ID
|
card_id | True | string |
Internal Card Id |
|
Time Unit
|
time_unit | True | string |
Time Unit |
|
Duration
|
time | True | integer |
Duration |
|
Comment
|
comment | string |
Comment |
Returns
Log Time (number of seconds) (deprecated) [DEPRECATED]
This action has been deprecated. Please use Log Time instead.
(Deprecated) Log time to a card. The time is logged in seconds.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content Type
|
Content-Type | True | string |
Always use: application/json |
|
Content Type
|
Accept | True | string |
Always use: application/json |
|
Card ID
|
card_id | string |
Internal Card Id |
|
|
Time
|
time | string |
Time in Seconds |
|
|
Comment
|
comment | string |
Comment |
Returns
Move Card
Move a card to new column, lane, workflow or board.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Card ID
|
card_id | True | integer |
Enter Card ID |
|
Board
|
board_id | True | integer |
Board must be selected from dropdown |
|
Workflow
|
workflow_id | True | integer |
Workflow must be selected from dropdown |
|
Column
|
column_id | True |
Select Column or Enter Column Name or ID as a Custom Value |
|
|
Lane
|
lane_id | True |
Select Lane or Enter Lane Name or ID as a Custom Value |
Returns
Move Card (deprecated) [DEPRECATED]
This action has been deprecated. Please use Move Card instead.
(Deprecated) Move a card (Task or Initiative, if possible) to a column.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content Type
|
Content-Type | True | string |
Always use: application/json |
|
Content Type
|
Accept | True | string |
Always use: application/json |
|
Card ID
|
taskid | string |
card id |
|
|
Board ID
|
boardid | True | string |
board id |
|
Column
|
column | string |
column name |
|
|
Lane
|
lane | string |
lane name |
|
|
Position
|
position | string |
card position in the column |
|
|
Exceeding reason
|
exceedingreason | string |
exceeding reason |
Returns
Set Custom Field Value
Set the value of a custom field.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Card ID
|
card_id | True | integer |
Enter Card ID |
|
Board ID
|
board_id | True | integer |
Board must be selected from dropdown |
|
Field Name
|
field_id | True | integer |
Select Custom Field |
|
Value
|
values | True | string |
Select from dropdown or enter custom values separated with a comma |
Returns
Set or Unset Stickers
Add sticker(s) to a card or remove assigned sticker(s) from a card
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Card ID
|
card_id | True | integer |
Enter Card ID |
|
Board
|
board_id | True | integer |
Board must be selected from dropdown |
|
Action
|
action | True | string |
Choose to set or unset stickers |
|
Stickers
|
stickers | True | string |
Select a single sticker from dropdown or enter multiple stickers separated with a comma |
|
If Sticker is Missing
|
missing_stickers | integer |
Select desired behaviour when a sticker is missing |
Returns
Set or Unset Tags
Add tag(s) to a card or remove assigned tag(s) from a card
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Card ID
|
card_id | True | integer |
Enter Card ID |
|
Board
|
board_id | True | integer |
Board must be selected from dropdown |
|
Action
|
action | True | string |
Choose to set or unset tags |
|
Tags
|
tags | True | string |
Select a single tag from dropdown or enter multiple tags separated with a comma |
|
If Tag is Missing
|
missing_tags | integer |
Select desired behaviour when a tag is missing |
Returns
Unblock Card
Unblock a card.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Card ID
|
card_id | True | integer |
Enter Card ID |
Returns
Unlink Cards
Remove a link between two cards.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unlink Card ID
|
card_id | True | integer |
Enter Card ID |
|
Linked as
|
link_type | True | string |
Select link type |
|
To Card Id
|
linked_card_id | True | integer |
Enter linked card id |
Returns
Update Card
Update the properties of a card (Title, Description, Priority, etc.). If getting a timeout or API limit reached errors, try breaking down the setting of custom fields, stickers and tags into separate actions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Card ID
|
card_id | True | integer |
Enter Card ID |
|
Board
|
board_id | True | integer |
Board must be selected from dropdown |
|
Workflow
|
workflow_id | integer |
Workflow must be selected from dropdown |
|
|
Template
|
template_id | integer |
Select Template |
|
|
Column
|
column_id |
Select Column or Enter Column Name or ID as a Custom Value |
||
|
Lane
|
lane_id |
Select Lane or Enter Lane Name or ID as a Custom Value |
||
|
Title
|
title | string |
Card Title |
|
|
Description
|
description | string |
Card Description |
|
|
Custom ID
|
custom_id | string |
Custom ID |
|
|
Owner
|
owner_user_id | integer |
Select Card Owner |
|
|
Type
|
type_id | integer |
Select Card Type |
|
|
Card Size
|
size | double |
Card Size |
|
|
Priority
|
priority | integer |
Select Priority |
|
|
Color
|
color | string |
Color (Hex, e.g. #000000) |
|
|
Deadline
|
deadline | string |
Deadline (Format: YYYY-MM-DD) |
|
|
Planned Start Date
|
planned_start_date | string |
Planned Start Date (Format: YYYY-MM-DD) (Initiatives Only) |
|
|
Planned End Date
|
planned_end_date | string |
Planned End Date (Format: YYYY-MM-DD) (Initiatives Only) |
|
|
Actual Start Time
|
actual_start_time | string |
Actual Start Time (Format: YYYY-MM-DDTHH:mm:ssZ) (Initiatives Only) |
|
|
Actual End Time
|
actual_end_time | string |
Actual End Time (Format: YYYY-MM-DDTHH:mm:ssZ) (Initiatives Only) |
|
|
Stickers
|
stickers | string |
Select stickers or add them as text separated with comma |
|
|
Tags
|
tags | string |
Select tags or add them as text separated with comma |
|
|
Name
|
field_id | integer |
Select Custom Field |
|
|
Value
|
value | string |
Custom Field Value |
Returns
- Body
- getCardResponse
Update Card (deprecated) [DEPRECATED]
This action has been deprecated. Please use Update Card instead.
(Deprecated) Update the properties of a card (Title, Description, Priority, etc.)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Content Type
|
Content-Type | True | string |
Always set to: application/json |
|
Accept
|
Accept | True | string |
Always set to: application/json |
|
Board ID
|
boardid | integer |
Select board from the dropdown list |
|
|
Card ID
|
taskid | integer |
card id |
|
|
Title
|
title | string |
title |
|
|
Description
|
description | string |
card details |
|
|
Priority
|
priority | string | ||
|
Assignee
|
assignee | string |
username of the assignee |
|
|
Color
|
color | string |
hex color code like this #F37325 |
|
|
Size
|
size | integer |
size |
|
|
Tags
|
tags | string |
multiple tags should be separated with space |
|
|
Custom Fields
|
cfields | string |
JSON formatted list of custom fields and their values {"field1":"value1","field2":"value2"} |
|
|
Deadline
|
deadline | string |
deadline date in this format YYYY-MM-DD |
|
|
External Link
|
extlink | string |
external link |
|
|
Type
|
type | string |
the name of the type you want to set |
Returns
Upload Attachment
Upload an attachment to a card.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Card ID
|
card_id | True | integer |
Enter Card ID |
|
File Name
|
file_name | True | string |
Enter File Name |
|
Content
|
content | True | binary |
Provide File Content (base64) |
Returns
Triggers
| General Trigger |
Triggers for any action on the board. Use Control/Condition or Control/Switch to manage flow for different triggers. Here is partial list of supported event types: "Card created", "Card moved", "Card details changed", "Card deleted", "Card blocked" \n\n Your next step after the trigger should be "Get Card By ID" so you can take all card details \n\nUse Control/Condition on author ID in bi-direction integrations to prevent loops |
General Trigger
Triggers for any action on the board. Use Control/Condition or Control/Switch to manage flow for different triggers. Here is partial list of supported event types: "Card created", "Card moved", "Card details changed", "Card deleted", "Card blocked" \n\n Your next step after the trigger should be "Get Card By ID" so you can take all card details \n\nUse Control/Condition on author ID in bi-direction integrations to prevent loops
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Board ID
|
board_id | True | string |
Select board |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
company
|
company | string |
company |
|
event
|
event | string |
event |
|
user_id
|
user_id | integer |
user_id |
|
board_id
|
board_id | integer |
board_id |
|
card_id
|
card_id | integer |
card_id |
Definitions
downloadAttachmentResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
File Name
|
data.file_name | string |
Attachment File Name |
|
Content
|
data.content | binary |
Attachment Content (base64) |
getAllCardsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
All Pages
|
data.pagination.all_pages | integer |
Total number of pages |
|
Current Page
|
data.pagination.current_page | integer |
Current page |
|
Results per page
|
data.pagination.results_per_page | integer |
Number of results per page |
|
data
|
data.data | array of object | |
|
Card Id
|
data.data.card_id | integer |
Internal Card ID |
|
Custom Card Id
|
data.data.custom_id | string |
Custom Card ID |
|
Board Id
|
data.data.board_id | integer |
Board ID of the card |
|
Workflow Id
|
data.data.workflow_id | integer |
Workflow ID of the card |
|
Card Title
|
data.data.title | string |
Title of the card |
|
Owner User Id
|
data.data.owner_user_id |
Owner ID of the card |
|
|
Type Id
|
data.data.type_id |
Card Type ID |
|
|
Color
|
data.data.color | string |
Color of the card |
|
Section
|
data.data.section | integer |
Section ID of the card |
|
Column Id
|
data.data.column_id | integer |
Column ID of the card |
|
Lane Id
|
data.data.lane_id | integer |
Lane ID of the card |
getCardAttachmentsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
data
|
data | array of object |
data |
|
id
|
data.id | integer |
Card Attachment ID |
|
file_name
|
data.file_name | string |
Card Attachment File Name |
|
link
|
data.link | string |
Card Attachment Link |
getCardResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Card Id
|
data.card_id | integer |
Internal Card ID |
|
Custom Card Id
|
data.custom_id | string |
Custom Card ID |
|
Board Id
|
data.board_id | integer |
Board ID of the card |
|
Workflow Id
|
data.workflow_id | integer |
Workflow ID of the card |
|
Card Title
|
data.title | string |
Title of the card |
|
Owner User Id
|
data.owner_user_id |
Owner ID of the card |
|
|
Type Id
|
data.type_id |
Card Type ID |
|
|
Color
|
data.color | string |
Color of the card |
|
Section
|
data.section | integer |
Section ID of the card |
|
Column Id
|
data.column_id | integer |
Column ID of the card |
|
Lane Id
|
data.lane_id | integer |
The lane ID of the card |
|
Position
|
data.position | integer |
Position of the card |
|
Card Description
|
data.description | string |
Description of the card |
|
Card Size
|
data.size |
Size of the card |
|
|
Priority
|
data.priority | integer |
Priority ID of the card |
|
Deadline
|
data.deadline | string |
Deadline of the card |
|
Type
|
data.reporter.type | string |
Type of value. Can be internal or external |
|
Reporter
|
data.reporter.value |
Reporter of the card |
|
|
Created At
|
data.created_at | string |
Timestamp of the creation of the card |
|
Last Modified
|
data.last_modified | string |
Timestamp of the last modification of the card |
|
Blocked
|
data.is_blocked | integer |
Boolean, whether the card is blocked |
|
Custom Fields
|
data.custom_fields | array of object |
Array of the custom fields assigned to the card |
|
Field Id
|
data.custom_fields.field_id | integer |
Custom Field ID |
|
Field Name
|
data.custom_fields.name | string |
Name of the custom field |
|
Field Value
|
data.custom_fields.value |
Value of the custom field |
|
|
Field Display Value
|
data.custom_fields.display_value |
Display value of the custom field |
|
|
values
|
data.custom_fields.values | array of object | |
|
Value Id
|
data.custom_fields.values.value_id | integer |
Custom Field Value ID |
|
Field Value
|
data.custom_fields.values.value |
Value of the custom field |
getObjectNameResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
name
|
data.name | string |
Name |
uploadAttachmentResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
data
|
data | array of object |
data |
|
Card Id
|
data.card_id | integer |
Internal Card ID |
|
File Name
|
data.file_name | string |
Name of the file to be uploaded |