Businessmap

Businessmap integration (Productivity). Imported from open-connector.

API key10 toolshttps://{account_host}/api/v2

GET

businessmap_list_workspaces

List Businessmap workspaces visible to the connected API key.

/workspaces

9 parameters

Param	Type	Required	Description
workspace_ids	array	optional	Workspace IDs to include.
type	integer	optional	Workspace type. Businessmap uses 1 for Team Workspace and 2 for Management Work…
is_archived	integer	optional	Set to 1 for archived workspaces or 0 for active workspaces.
if_workspace_manager	integer	optional	Set to 1 to return workspaces where the current user is a manager.
if_assigned_to_boards	integer	optional	Set to 1 to return workspaces where the current user is assigned.
board_filter_is_archived	integer	optional	Board archive filter used when expand includes boards.
board_filter_if_assigned	integer	optional	Board assignment filter used when expand includes boards.
fields	array	optional	Workspace fields to include in the response.
expand	array	optional	Workspace relationships to expand.

GET

businessmap_list_boards

List Businessmap boards visible to the connected API key.

/boards

6 parameters

Param	Type	Required	Description
board_ids	array	optional	Board IDs to include.
workspace_ids	array	optional	Workspace IDs whose boards should be returned.
is_archived	integer	optional	Set to 1 for archived boards or 0 for active boards.
if_assigned	integer	optional	Set to 1 to return boards assigned to the current user.
fields	array	optional	Board fields to include in the response.
expand	array	optional	Board relationships to expand.

GET

businessmap_get_board

Retrieve a Businessmap board by ID.

/boards/{board_id}

1 parameter

Param	Type	Required	Description
board_id	integer	required	The Businessmap board ID.

POST

businessmap_create_board

Create a Businessmap board in a workspace.

/boards

4 parameters

Param	Type	Required	Description
workspace_id	integer	required	The workspace ID to which the board belongs.
name	string	required	The board name.
description	string	optional	The board description.
type	integer	optional	The board type. Businessmap uses 1 for Kanban board and 2 for AI Canvas.

PATCH

businessmap_update_board

Update a Businessmap board name, description, or archive state.

/boards/{board_id}

4 parameters

Param	Type	Required	Description
board_id	integer	required	The Businessmap board ID.
name	string	optional	The updated board name.
description	string	optional	The updated board description.
is_archived	integer	optional	Set to 1 to archive the board or 0 to unarchive it.

GET

businessmap_list_cards

List Businessmap cards with common board, workflow, state, and date filters.

/cards

21 parameters

Param	Type	Required	Description
card_ids	array	optional	Card IDs to include.
board_ids	array	optional	Board IDs whose cards should be returned.
workflow_ids	array	optional	Workflow IDs whose cards should be returned.
state	string	optional	The Businessmap card state.
created_from	string	optional	Earliest card creation date-time in Businessmap format.
created_from_date	string	optional	Earliest card creation date in YYYY-MM-DD format.
created_to	string	optional	Latest card creation date-time in Businessmap format.
created_to_date	string	optional	Latest card creation date in YYYY-MM-DD format.
last_modified_from	string	optional	Earliest card modification date-time in Businessmap format.
last_modified_from_date	string	optional	Earliest card modification date in YYYY-MM-DD format.
last_modified_to	string	optional	Latest card modification date-time in Businessmap format.
last_modified_to_date	string	optional	Latest card modification date in YYYY-MM-DD format.
is_blocked	integer	optional	Set to 1 to return blocked cards or 0 for unblocked cards.
custom_ids	array	optional	Custom card IDs to include.
owner_user_ids	array	optional	Owner user IDs to include.
type_ids	array	optional	Card type IDs to include.
priorities	array	optional	Businessmap card priority values to include.
fields	array	optional	Card fields to include in the response.
expand	array	optional	Card relationships to expand in the response.
page	integer	optional	The Businessmap results page to request.
per_page	integer	optional	The number of cards to return per page.

GET

businessmap_get_card

Retrieve a Businessmap card by ID.

/cards/{card_id}

1 parameter

Param	Type	Required	Description
card_id	integer	required	The Businessmap card ID.

POST

businessmap_create_card

Create a Businessmap card using JSON card fields.

/cards

32 parameters

Param	Type	Required	Description
column_id	integer	required	The column ID where the card should be placed.
lane_id	integer	required	The lane ID where the card should be placed.
position	integer	optional	The zero-based card position in the column.
track	integer	optional	The timeline workflow track number.
planned_start_date	string	optional	The planned start date in YYYY-MM-DD format.
planned_end_date	string	optional	The planned end date in YYYY-MM-DD format.
actual_start_time	string	optional	The actual start time as an ISO 8601 timestamp.
actual_end_time	string	optional	The actual end time as an ISO 8601 timestamp.
title	string	required	The card title.
description	string	optional	The card description.
custom_id	string	optional	—
owner_user_id	integer	optional	—
type_id	integer	optional	—
size	number	optional	—
priority	integer	optional	—
color	string	optional	The card color in hexadecimal format.
deadline	string	optional	—
reference	string	optional	A caller-provided reference used to find the created card.
tag_ids_to_add	array	optional	Tag IDs to add to the card.
tag_ids_to_remove	array	optional	Tag IDs to remove from the card.
milestone_ids_to_add	array	optional	Milestone IDs to add to the card.
milestone_ids_to_remove	array	optional	Milestone IDs to remove from the card.
co_owner_ids_to_add	array	optional	User IDs to add as co-owners.
co_owner_ids_to_remove	array	optional	User IDs to remove as co-owners.
watcher_ids_to_add	array	optional	User IDs to add as watchers.
watcher_ids_to_remove	array	optional	User IDs to remove as watchers.
watch	integer	optional	Set to 1 for the current user to watch the card.
is_archived	integer	optional	Set to 1 to archive the card.
is_discarded	integer	optional	Set to 1 to discard the card.
exceeding_reason	string	optional	—
reporter_user_id	integer	optional	—
reporter_email	string	optional	—

PATCH

businessmap_update_card

Update a Businessmap card using JSON card fields.

/cards/{card_id}

33 parameters

Param	Type	Required	Description
card_id	integer	required	The Businessmap card ID.
column_id	integer	optional	The column ID where the card should be placed.
lane_id	integer	optional	The lane ID where the card should be placed.
position	integer	optional	The zero-based card position in the column.
track	integer	optional	The timeline workflow track number.
planned_start_date	string	optional	The planned start date in YYYY-MM-DD format.
planned_end_date	string	optional	The planned end date in YYYY-MM-DD format.
actual_start_time	string	optional	The actual start time as an ISO 8601 timestamp.
actual_end_time	string	optional	The actual end time as an ISO 8601 timestamp.
title	string	optional	The card title.
description	string	optional	The card description.
custom_id	string	optional	—
owner_user_id	integer	optional	—
type_id	integer	optional	—
size	number	optional	—
priority	integer	optional	—
color	string	optional	The card color in hexadecimal format.
deadline	string	optional	—
reference	string	optional	A caller-provided reference used to find the created card.
tag_ids_to_add	array	optional	Tag IDs to add to the card.
tag_ids_to_remove	array	optional	Tag IDs to remove from the card.
milestone_ids_to_add	array	optional	Milestone IDs to add to the card.
milestone_ids_to_remove	array	optional	Milestone IDs to remove from the card.
co_owner_ids_to_add	array	optional	User IDs to add as co-owners.
co_owner_ids_to_remove	array	optional	User IDs to remove as co-owners.
watcher_ids_to_add	array	optional	User IDs to add as watchers.
watcher_ids_to_remove	array	optional	User IDs to remove as watchers.
watch	integer	optional	Set to 1 for the current user to watch the card.
is_archived	integer	optional	Set to 1 to archive the card.
is_discarded	integer	optional	Set to 1 to discard the card.
exceeding_reason	string	optional	—
reporter_user_id	integer	optional	—
reporter_email	string	optional	—

DELETE

businessmap_delete_card

Permanently delete a Businessmap card.

/cards/{card_id}

2 parameters

Param	Type	Required	Description
card_id	integer	required	The Businessmap card ID.
exceeding_reason	string	optional	—