MondayClient

Attributes

FieldWorkspace module-attribute

FieldWorkspace = str

FieldBoard module-attribute

FieldBoard = str

FieldColumnsToUpdateSingleColumn module-attribute

FieldColumnsToUpdateSingleColumn = str

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'WebhookCreateItem': {'operation_id': 'WebhookCreateItem', 'path': '/{connectionId}/registerWebhook/CreateItem', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'WebhookCreateItemResponse'}, 'WebhookCreateUpdate': {'operation_id': 'WebhookCreateUpdate', 'path': '/{connectionId}/registerWebhook/CreateUpdate', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'WebhookCreateUpdateResponse'}, 'WebhookChangeName': {'operation_id': 'WebhookChangeName', 'path': '/{connectionId}/registerWebhook/ChangeName', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'WebhookChangeNameResponse'}, 'WebhookChangeSubitemName': {'operation_id': 'WebhookChangeSubitemName', 'path': '/{connectionId}/registerWebhook/ChangeSubitemName', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'WebhookChangeSubitemNameResponse'}, 'WebhookCreateSubitem': {'operation_id': 'WebhookCreateSubitem', 'path': '/{connectionId}/registerWebhook/CreateSubitem', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'WebhookCreateSubitemResponse'}, 'WebhookColumnChanges': {'operation_id': 'WebhookColumnChanges', 'path': '/{connectionId}/registerWebhook/ColumnChanges', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'WebhookColumnChangesResponse'}, 'WebhookAnyColumnChanges': {'operation_id': 'WebhookAnyColumnChanges', 'path': '/{connectionId}/registerWebhook/AnyColumnChanges', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'WebhookAnyColumnChangesResponse'}, 'WebhookSubitemColumnChanges': {'operation_id': 'WebhookSubitemColumnChanges', 'path': '/{connectionId}/registerWebhook/SubitemColumnChanges', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'WebhookSubitemColumnChangesResponse'}}

Classes

WebhookCreateItemInput dataclass

WebhookCreateItemInput(workspace_id: str, board_id: str, callback_url: str)

When an item is created

Attributes

workspace_id class-attribute instance-attribute

workspace_id: str = dataclass_field(metadata={'wire_name': 'workspaceId'})

Select a workspace from the drop-down or specify a workspace ID.

board_id class-attribute instance-attribute

board_id: str = dataclass_field(metadata={'wire_name': 'boardId'})

Select a board from the drop-down or specify a board ID.

callback_url class-attribute instance-attribute

callback_url: str = dataclass_field(metadata={'wire_name': 'callbackUrl'})

Specify the callback URL

WebhookCreateItemResponse dataclass

WebhookCreateItemResponse(*, additional_properties: Dict[str, Any] = dict())

Response for When an item is created

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

WebhookCreateUpdateInput dataclass

WebhookCreateUpdateInput(workspace_id: str, board_id: str, callback_url: str)

When a new update is posted

Attributes

workspace_id class-attribute instance-attribute

workspace_id: str = dataclass_field(metadata={'wire_name': 'workspaceId'})

Select a workspace from the drop-down or specify a workspace ID.

board_id class-attribute instance-attribute

board_id: str = dataclass_field(metadata={'wire_name': 'boardId'})

Select a board from the drop-down or specify a board ID.

callback_url class-attribute instance-attribute

callback_url: str = dataclass_field(metadata={'wire_name': 'callbackUrl'})

Specify the callback URL.

WebhookCreateUpdateResponse dataclass

WebhookCreateUpdateResponse(*, additional_properties: Dict[str, Any] = dict())

Response for When a new update is posted

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

WebhookChangeNameInput dataclass

WebhookChangeNameInput(workspace_id: str, board_id: str, callback_url: str)

When an item's name changes

Attributes

workspace_id class-attribute instance-attribute

workspace_id: str = dataclass_field(metadata={'wire_name': 'workspaceId'})

Select a workspace from the drop-down or specify a workspace ID.

board_id class-attribute instance-attribute

board_id: str = dataclass_field(metadata={'wire_name': 'boardId'})

Select a board from the drop-down or specify a board ID.

callback_url class-attribute instance-attribute

callback_url: str = dataclass_field(metadata={'wire_name': 'callbackUrl'})

Specify the callback URL.

WebhookChangeNameResponse dataclass

WebhookChangeNameResponse(*, additional_properties: Dict[str, Any] = dict())

Response for When an item's name changes

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

WebhookChangeSubitemNameInput dataclass

WebhookChangeSubitemNameInput(workspace_id: str, board_id: str, callback_url: str)

When a subitem's name changes

Attributes

workspace_id class-attribute instance-attribute

workspace_id: str = dataclass_field(metadata={'wire_name': 'workspaceId'})

Select a workspace from the drop-down or specify a workspace ID.

board_id class-attribute instance-attribute

board_id: str = dataclass_field(metadata={'wire_name': 'boardId'})

Select a board from the drop-down or specify a board ID.

callback_url class-attribute instance-attribute

callback_url: str = dataclass_field(metadata={'wire_name': 'callbackUrl'})

Specify the callback URL.

WebhookChangeSubitemNameResponse dataclass

WebhookChangeSubitemNameResponse(*, additional_properties: Dict[str, Any] = dict())

Response for When a subitem's name changes

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

WebhookCreateSubitemInput dataclass

WebhookCreateSubitemInput(workspace_id: str, board_id: str, callback_url: str)

When a subitem is created

Attributes

workspace_id class-attribute instance-attribute

workspace_id: str = dataclass_field(metadata={'wire_name': 'workspaceId'})

Select a workspace from the drop-down or specify a workspace ID.

board_id class-attribute instance-attribute

board_id: str = dataclass_field(metadata={'wire_name': 'boardId'})

Select a board from the drop-down or specify a board ID.

callback_url class-attribute instance-attribute

callback_url: str = dataclass_field(metadata={'wire_name': 'callbackUrl'})

Specify the callback URL.

WebhookCreateSubitemResponse dataclass

WebhookCreateSubitemResponse(*, additional_properties: Dict[str, Any] = dict())

Response for When a subitem is created

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

WebhookColumnChangesInput dataclass

WebhookColumnChangesInput(workspace_id: str, board_id: str, column_id: str, callback_url: str)

When a column changes

Attributes

workspace_id class-attribute instance-attribute

workspace_id: str = dataclass_field(metadata={'wire_name': 'workspaceId'})

Select a workspace from the drop-down or specify a workspace ID.

board_id class-attribute instance-attribute

board_id: str = dataclass_field(metadata={'wire_name': 'boardId'})

Select a board from the drop-down or specify a board ID.

column_id class-attribute instance-attribute

column_id: str = dataclass_field(metadata={'wire_name': 'columnId'})

Select a column from the drop-down.

callback_url class-attribute instance-attribute

callback_url: str = dataclass_field(metadata={'wire_name': 'callbackUrl'})

Specify the callback URL.

WebhookColumnChangesResponse dataclass

WebhookColumnChangesResponse(*, additional_properties: Dict[str, Any] = dict())

Response for When a column changes

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

WebhookAnyColumnChangesInput dataclass

WebhookAnyColumnChangesInput(workspace_id: str, board_id: str, callback_url: str)

When any column changes

Attributes

workspace_id class-attribute instance-attribute

workspace_id: str = dataclass_field(metadata={'wire_name': 'workspaceId'})

Select a workspace from the drop-down or specify a workspace ID.

board_id class-attribute instance-attribute

board_id: str = dataclass_field(metadata={'wire_name': 'boardId'})

Select a board from the drop-down or specify a board ID.

callback_url class-attribute instance-attribute

callback_url: str = dataclass_field(metadata={'wire_name': 'callbackUrl'})

Specify the callback URL.

WebhookAnyColumnChangesResponse dataclass

WebhookAnyColumnChangesResponse(*, additional_properties: Dict[str, Any] = dict())

Response for When any column changes

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

WebhookSubitemColumnChangesInput dataclass

WebhookSubitemColumnChangesInput(workspace_id: str, board_id: str, callback_url: str)

When any subitem column changes

Attributes

workspace_id class-attribute instance-attribute

workspace_id: str = dataclass_field(metadata={'wire_name': 'workspaceId'})

Select a workspace from the drop-down or specify a workspace ID.

board_id class-attribute instance-attribute

board_id: str = dataclass_field(metadata={'wire_name': 'boardId'})

Select a board from the drop-down or specify a board ID.

callback_url class-attribute instance-attribute

callback_url: str = dataclass_field(metadata={'wire_name': 'callbackUrl'})

Specify the callback URL.

WebhookSubitemColumnChangesResponse dataclass

WebhookSubitemColumnChangesResponse(*, additional_properties: Dict[str, Any] = dict())

Response for When any subitem column changes

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

CreateItemInput dataclass

CreateItemInput(workspace_id: FieldWorkspace, board_id: FieldBoard, group_id: str, item_name: str, *, column_values: Optional[DynamicResponseGetListSchema | Mapping[str, Any]] = None)

Create an item

Attributes

group_id class-attribute instance-attribute

group_id: str = dataclass_field(metadata={'wire_name': 'groupId'})

Select a group from the drop-down or specify a group ID.

item_name class-attribute instance-attribute

item_name: str = dataclass_field(metadata={'wire_name': 'itemName'})

Specify the name of the item you want to create.

CreateItemResponse dataclass

CreateItemResponse(*, data: Optional[Dict[str, Any]] = None)

Response for Create an item

DuplicateBoardInput dataclass

DuplicateBoardInput(source_workspace_id: str, source_board_id: str, duplication_type: str, keep_board_subscribers: bool, *, duplicated_board_name: Optional[str] = None, destination_workspace_id: Optional[str] = None, destination_folder: Optional[str] = None)

Duplicate a board

Attributes

source_workspace_id class-attribute instance-attribute

source_workspace_id: str = dataclass_field(metadata={'wire_name': 'sourceWorkspaceId'})

Select the workspace for the board you want to duplicate.

source_board_id class-attribute instance-attribute

source_board_id: str = dataclass_field(metadata={'wire_name': 'sourceBoardId'})

Select the board to duplicate.

duplicated_board_name class-attribute instance-attribute

duplicated_board_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'duplicatedBoardName'})

Specify the name of the duplicated board.

duplication_type class-attribute instance-attribute

duplication_type: str = dataclass_field(metadata={'wire_name': 'duplicationType'})

Select the duplication type from the drop-down.

destination_workspace_id class-attribute instance-attribute

destination_workspace_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'destinationWorkspaceId'})

Select the destination workspace for the duplicated board.

destination_folder class-attribute instance-attribute

destination_folder: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'destinationFolder'})

Select the destination folder for the duplicated board.

keep_board_subscribers class-attribute instance-attribute

keep_board_subscribers: bool = dataclass_field(metadata={'wire_name': 'keepBoardSubscribers'})

Select whether to keep board subscribers.

DuplicateBoardResponse dataclass

DuplicateBoardResponse(*, id: Optional[str] = None)

Response for Duplicate a board

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The ID of the duplicated board

CreateBoardInput dataclass

CreateBoardInput(workspace_id: str, board_name: str)

Create a board

Attributes

workspace_id class-attribute instance-attribute

workspace_id: str = dataclass_field(metadata={'wire_name': 'workspaceId'})

Specify the ID of a monday.com workspace.

board_name class-attribute instance-attribute

board_name: str = dataclass_field(metadata={'wire_name': 'boardName'})

Specify the desired name of the board you want to create.

CreateBoardResponse dataclass

CreateBoardResponse(*, data: Optional[Dict[str, Any]] = None)

Response for Create a board

CreateColumnInput dataclass

CreateColumnInput(workspace_id: FieldWorkspace, board_id: FieldBoard, title: str, column_type: str, *, description: Optional[str] = None)

Create a column

Attributes

title instance-attribute

title: str

Specify the title of the column you want to create.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Specify the description of the column you want to create.

column_type class-attribute instance-attribute

column_type: str = dataclass_field(metadata={'wire_name': 'columnType'})

Select a column type from the drop-down.

CreateColumnResponse dataclass

CreateColumnResponse(*, data: Optional[Dict[str, Any]] = None)

Response for Create a column

CreateGroupInput dataclass

CreateGroupInput(workspace_id: FieldWorkspace, board_id: FieldBoard, group_name: str)

Create a group

Attributes

group_name class-attribute instance-attribute

group_name: str = dataclass_field(metadata={'wire_name': 'groupName'})

Specify your desired group name.

CreateGroupResponse dataclass

CreateGroupResponse(*, data: Optional[Dict[str, Any]] = None)

Response for Create a group

UpdateItemColumnInput dataclass

UpdateItemColumnInput(workspace_id: str, board_id: str, column_id: FieldColumnsToUpdateSingleColumn, item_id: str, column_values: DynamicResponseGetSingleColumnSchema | Mapping[str, Any])

Update an item's column value

Attributes

workspace_id class-attribute instance-attribute

workspace_id: str = dataclass_field(metadata={'wire_name': 'workspaceId'})

Select the workspace the item belongs to from the drop-down.

board_id class-attribute instance-attribute

board_id: str = dataclass_field(metadata={'wire_name': 'boardId'})

Select the board the item belongs to from the drop-down.

item_id class-attribute instance-attribute

item_id: str = dataclass_field(metadata={'wire_name': 'itemId'})

Specify the ID of the item to update.

UpdateItemColumnResponse dataclass

UpdateItemColumnResponse(*, data: Optional[Dict[str, Any]] = None)

Response for Update an item's column value

UpdateMultipleItemColumnsInput dataclass

UpdateMultipleItemColumnsInput(workspace_id: str, board_id: str, item_id: str, *, item_name: Optional[str] = None, column_values: Optional[DynamicResponseGetListSchema | Mapping[str, Any]] = None)

Update multiple item column values

Attributes

workspace_id class-attribute instance-attribute

workspace_id: str = dataclass_field(metadata={'wire_name': 'workspaceId'})

Select the workspace the item belongs to from the drop-down.

board_id class-attribute instance-attribute

board_id: str = dataclass_field(metadata={'wire_name': 'boardId'})

Select the board the item belongs to from the drop-down.

item_id class-attribute instance-attribute

item_id: str = dataclass_field(metadata={'wire_name': 'itemId'})

Specify the ID of the item to update.

item_name class-attribute instance-attribute

item_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'itemName'})

Specify a new name for the item. Leave blank to keep the current name.

UpdateMultipleItemColumnsResponse dataclass

UpdateMultipleItemColumnsResponse(*, data: Optional[Dict[str, Any]] = None)

Response for Update multiple item column values

MoveItemToGroupInput dataclass

MoveItemToGroupInput(workspace_id: FieldWorkspace, board_id: FieldBoard, group_id: str, item_id: str)

Move an item to a group

Attributes

group_id class-attribute instance-attribute

group_id: str = dataclass_field(metadata={'wire_name': 'groupId'})

Select the group to move the item to from the drop-down.

item_id class-attribute instance-attribute

item_id: str = dataclass_field(metadata={'wire_name': 'itemId'})

Specify the ID of the item to move.

MoveItemToGroupResponse dataclass

MoveItemToGroupResponse(*, data: Optional[Dict[str, Any]] = None)

Response for Move an item to a group

CreateNotificationInput dataclass

CreateNotificationInput(user_id: str, target_id: str, text: str)

Create a notification

Attributes

user_id class-attribute instance-attribute

user_id: str = dataclass_field(metadata={'wire_name': 'userId'})

Select a user from the drop-down or specify a user ID.

target_id class-attribute instance-attribute

target_id: str = dataclass_field(metadata={'wire_name': 'targetId'})

Specify a board ID or item ID the notification will go to.

text instance-attribute

text: str

Specify the notification text.

CreateNotificationResponse dataclass

CreateNotificationResponse(*, data: Optional[Dict[str, Any]] = None)

Response for Create a notification

Attributes

data class-attribute instance-attribute

data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Data

CreateSubitemInput dataclass

CreateSubitemInput(workspace_id: FieldWorkspace, board_id: str, parent_item_id: str, item_name: str, *, column_values: Optional[DynamicResponseGetListSchema | Mapping[str, Any]] = None)

Create a subitem

Attributes

board_id class-attribute instance-attribute

board_id: str = dataclass_field(metadata={'wire_name': 'boardId'})

Select a board from the drop-down or specify a board ID.

parent_item_id class-attribute instance-attribute

parent_item_id: str = dataclass_field(metadata={'wire_name': 'parentItemId'})

Select a parent item from the drop-down or specify a parent item ID.

item_name class-attribute instance-attribute

item_name: str = dataclass_field(metadata={'wire_name': 'itemName'})

Specify a name for the subitem.

CreateSubitemResponse dataclass

CreateSubitemResponse(*, data: Optional[Dict[str, Any]] = None)

Response for Create a subitem

GetSubitemColumnNamesForGetSubitems dataclass

GetSubitemColumnNamesForGetSubitems(*, additional_properties: Dict[str, Any] = dict())

Response for Get subitems

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

CreateUpdateInput dataclass

CreateUpdateInput(workspace_id: FieldWorkspace, board_id: FieldBoard, group_id: str, item_id: str, body: str)

Create an update

Attributes

group_id class-attribute instance-attribute

group_id: str = dataclass_field(metadata={'wire_name': 'groupId'})

Select a group from the drop-down or specify a group ID.

item_id class-attribute instance-attribute

item_id: str = dataclass_field(metadata={'wire_name': 'itemId'})

Select an item from the drop-down or specify an item ID.

body instance-attribute

body: str

Specify text for the update.

CreateUpdateResponse dataclass

CreateUpdateResponse(*, data: Optional[Dict[str, Any]] = None)

Response for Create an update

DynamicResponseGetListSchemaGet dataclass

DynamicResponseGetListSchemaGet(*, additional_properties: Dict[str, Any] = dict())

Response for Get an item by ID

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

CreateWorkspaceInput dataclass

CreateWorkspaceInput(name: str, *, description: Optional[str] = None)

Create a workspace

Attributes

name instance-attribute

name: str

Specify a name for the new workspace.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Specify a description for the new workspace.

CreateWorkspaceResponse dataclass

CreateWorkspaceResponse(*, data: Optional[Dict[str, Any]] = None)

Response for Create a workspace

DynamicGetGetItemsSchema dataclass

DynamicGetGetItemsSchema(*, additional_properties: Dict[str, Any] = dict())

Response for Get items

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

GetTagsResponse dataclass

GetTagsResponse(*, data: Optional[Dict[str, Any]] = None)

Response for Get tags

GetUsersResponse dataclass

GetUsersResponse(*, data: Optional[Dict[str, Any]] = None)

Response for Get users

GetWorkspacesResponse dataclass

GetWorkspacesResponse(*, data: Optional[Dict[str, Any]] = None)

Response for Get workspaces

Attributes

data class-attribute instance-attribute

data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

data

GetColumnNamesSchemaResponse dataclass

GetColumnNamesSchemaResponse(*, schema: Optional[Dict[str, Any]] = None)

Response for Get column names for a board ID

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Schema of the requested schema type

GetSingleColumnSchemaResponse dataclass

GetSingleColumnSchemaResponse(*, schema: Optional[Dict[str, Any]] = None)

Response for Gets single column schema for a board ID

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Schema of the requested schema type

GetColumnNamesSchemaForWebhookResponse dataclass

GetColumnNamesSchemaForWebhookResponse(*, schema: Optional[Dict[str, Any]] = None)

Response for Get column names for a board ID for a webhook

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Schema of the requested schema type

GetSchemaForGetItemsActionResponse dataclass

GetSchemaForGetItemsActionResponse(*, schema: Optional[Dict[str, Any]] = None)

Response for Get column names for a board ID for a webhook

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Schema of the requested schema type

GetColumnNamesSchemaForUpdateWebhookResponse dataclass

GetColumnNamesSchemaForUpdateWebhookResponse(*, schema: Optional[Dict[str, Any]] = None)

Response for Get column names for a board ID for an update webhook

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Schema of the requested schema type

GetSubitemColumnNamesResponse dataclass

GetSubitemColumnNamesResponse(*, schema: Optional[Dict[str, Any]] = None)

Response for Get subitem column names

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Schema of the requested schema type

GetSubitemSchemaResponse dataclass

GetSubitemSchemaResponse(*, schema: Optional[Dict[str, Any]] = None)

Response for Get subitem column names

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Schema of the requested schema type

GetColumnNamesSchemaForItemNameChangeWebhookResponse dataclass

GetColumnNamesSchemaForItemNameChangeWebhookResponse(*, schema: Optional[Dict[str, Any]] = None)

Response for Get column names schema for column changes

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Schema of the requested schema type

GetColumnNamesSchemaForSubitemNameChangeWebhookResponse dataclass

GetColumnNamesSchemaForSubitemNameChangeWebhookResponse(*, schema: Optional[Dict[str, Any]] = None)

Response for Get column names schema for column changes

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Schema of the requested schema type

GetColumnNamesSchemaForColumnChangesWebhookResponse dataclass

GetColumnNamesSchemaForColumnChangesWebhookResponse(*, schema: Optional[Dict[str, Any]] = None)

Response for Get column names schema for column changes

Attributes

schema class-attribute instance-attribute

schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Schema of the requested schema type

DynamicResponseGetListSchema dataclass

DynamicResponseGetListSchema(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicResponseGetListSchema

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicResponseGetSingleColumnSchema dataclass

DynamicResponseGetSingleColumnSchema(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicResponseGetSingleColumnSchema

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicGetColumnNamesForWebhook dataclass

DynamicGetColumnNamesForWebhook(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicGetColumnNamesForWebhook

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicGetColumnNamesForUpdateWebhook dataclass

DynamicGetColumnNamesForUpdateWebhook(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicGetColumnNamesForUpdateWebhook

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicGetSubitemColumnNamesForWebhook dataclass

DynamicGetSubitemColumnNamesForWebhook(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicGetSubitemColumnNamesForWebhook

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

MondayClient

MondayClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for monday connector.

Initialize a MondayClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

create_item async

create_item(input: CreateItemInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create an item

Creates an item in the selected monday.com board and group.

Swagger operation ID: CreateItem.

Parameters:

Name	Type	Description	Default
input	CreateItemInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

duplicate_board async

duplicate_board(input: DuplicateBoardInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Duplicate a board

Duplicates a board in monday.com.

Swagger operation ID: DuplicateBoard.

Parameters:

Name	Type	Description	Default
input	DuplicateBoardInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_board async

create_board(input: CreateBoardInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a board

Creates a board in monday.com.

Swagger operation ID: CreateBoard.

Parameters:

Name	Type	Description	Default
input	CreateBoardInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_column async

create_column(input: CreateColumnInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a column

Creates a column in monday.com for the specified board.

Swagger operation ID: CreateColumn.

Parameters:

Name	Type	Description	Default
input	CreateColumnInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_group async

create_group(input: CreateGroupInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a group

Creates a group in monday.com for the specified board.

Swagger operation ID: CreateGroup.

Parameters:

Name	Type	Description	Default
input	CreateGroupInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_item_column async

update_item_column(input: UpdateItemColumnInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update an item's column value

Updates a single item's column. If the value is blank, the column value will be cleared.

Swagger operation ID: UpdateItemColumn.

Parameters:

Name	Type	Description	Default
input	UpdateItemColumnInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_multiple_item_columns async

update_multiple_item_columns(input: UpdateMultipleItemColumnsInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update multiple item column values

Updates multiple item columns. Leave the column value blank to keep the current value.

Swagger operation ID: UpdateMultipleItemColumns.

Parameters:

Name	Type	Description	Default
input	UpdateMultipleItemColumnsInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

move_item_to_group async

move_item_to_group(input: MoveItemToGroupInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Move an item to a group

Moves an item to another group on the same board.

Swagger operation ID: MoveItemToGroup.

Parameters:

Name	Type	Description	Default
input	MoveItemToGroupInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_notification async

create_notification(input: CreateNotificationInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a notification

Creates a notification in monday.com for a user for either a specific board or item.

Swagger operation ID: CreateNotification.

Parameters:

Name	Type	Description	Default
input	CreateNotificationInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_subitem async

create_subitem(input: CreateSubitemInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a subitem

Creates a subitem in monday.com for the selected board and parent item.

Swagger operation ID: CreateSubitem.

Parameters:

Name	Type	Description	Default
input	CreateSubitemInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_subitems async

get_subitems(workspace_id: str, board_id: str, item_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get subitems

Gets subitems in monday.com for a specific item in a board.

Swagger operation ID: GetSubitems.

Parameters:

Name	Type	Description	Default
workspace_id	str	Select a workspace from the drop-down or specify a workspace ID.	required
board_id	str	Select the item's board from the drop-down or specify a board ID.	required
item_id	str	Specify an item ID to retrieve the subitems for.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_update async

create_update(input: CreateUpdateInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create an update

Creates an update in monday.com for a specific item.

Swagger operation ID: CreateUpdate.

Parameters:

Name	Type	Description	Default
input	CreateUpdateInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_item_by_id async

get_item_by_id(item_id: str, workspace_id: str, board_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get an item by ID

Gets a monday.com item using the specified item ID and board.

Swagger operation ID: GetItemById.

Parameters:

Name	Type	Description	Default
item_id	str	Specify an item ID to retrieve.	required
workspace_id	str	Select the item's workspace from the drop-down or specify a workspace ID.	required
board_id	str	Select the item's board from the drop-down or specify a board ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_workspace async

create_workspace(input: CreateWorkspaceInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a workspace

Creates a monday.com workspace with a user-specified name and description.

Swagger operation ID: CreateWorkspace_V2.

Parameters:

Name	Type	Description	Default
input	CreateWorkspaceInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_items async

get_items(workspace_id: str, board_id: str, group_id: str, *, filter1_column: Optional[str] = None, filter1_operator: Optional[str] = None, filter1_value: Optional[str] = None, filter2_column: Optional[str] = None, filter2_operator: Optional[str] = None, filter2_value: Optional[str] = None, filter3_column: Optional[str] = None, filter3_operator: Optional[str] = None, filter3_value: Optional[str] = None, filter4_column: Optional[str] = None, filter4_operator: Optional[str] = None, filter4_value: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get items

Gets items in monday.com for a specific board and group. Filter items by column values using the filters found under advanced options. More info on filtering can be found here: https://plugingenie.com/docs/filtering-items.

Swagger operation ID: GetItems_V2.

Parameters:

Name	Type	Description	Default
workspace_id	str	Select a workspace from the drop-down or specify a workspace ID.	required
board_id	str	Select a board from the drop-down or specify a board ID.	required
group_id	str	Select a group from the drop-down or specify a group ID.	required
filter1_column	Optional[str]	Select a column from the drop-down or specify a column ID.	None
filter1_operator	Optional[str]	Select an operator from the drop-down.	None
filter1_value	Optional[str]	Specify a value (if applicable).	None
filter2_column	Optional[str]	Select a column from the drop-down or specify a column ID.	None
filter2_operator	Optional[str]	Select an operator from the drop-down.	None
filter2_value	Optional[str]	Specify a value (if applicable).	None
filter3_column	Optional[str]	Select a column from the drop-down or specify a column ID.	None
filter3_operator	Optional[str]	Select an operator from the drop-down.	None
filter3_value	Optional[str]	Specify a value (if applicable).	None
filter4_column	Optional[str]	Select a column from the drop-down or specify a column ID.	None
filter4_operator	Optional[str]	Select an operator from the drop-down.	None
filter4_value	Optional[str]	Specify a value (if applicable).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_tags async

get_tags(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get tags

This operation gets monday.com tags.

Swagger operation ID: GetTags_V2.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_users async

get_users(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get users

This operation gets the name, email, and ID of users in your monday.com account.

Swagger operation ID: GetUsers_V2.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_workspaces async

get_workspaces(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get workspaces

This operation gets the workspaces from monday.com.

Swagger operation ID: GetWorkspaces_V2.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_boards

list_boards(*, workspace_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get boards

This operation gets the boards from monday.com.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetBoards.

Parameters:

Name	Type	Description	Default
workspace_id	Optional[str]	Specify the ID of the monday.com workspace.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_groups_for_get_items

list_groups_for_get_items(board_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get groups for the Get Items operation

This operation gets the groups from monday.com, which includes the option to select all groups.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetGroupsForGetItems.

Parameters:

Name	Type	Description	Default
board_id	str	Specify the ID of a monday.com board.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_columns_for_item_filtering

list_columns_for_item_filtering(board_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get columns for item filtering

This operation gets the columns from monday.com for item filtering.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetColumnsForItemFiltering.

Parameters:

Name	Type	Description	Default
board_id	str	Specify the ID of a monday.com board.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_column_filter_operator

list_column_filter_operator(board_id: str, *, column_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get column filter operator

This operation gets the available item filter operator for the selected monday.com column.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetColumnFilterOperator.

Parameters:

Name	Type	Description	Default
board_id	str	Specify the ID of a monday.com board.	required
column_id	Optional[str]	Specify the ID of a monday.com column.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_column_names_schema async

get_column_names_schema(*, board_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get column names for a board ID

This operation gets the column names for a board ID.

Swagger operation ID: GetColumnNamesSchema.

Parameters:

Name	Type	Description	Default
board_id	Optional[str]	Specify the ID of a monday.com board.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_single_column_schema async

get_single_column_schema(*, board_id: Optional[str] = None, column_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Gets single column schema for a board ID

This operation gets the single column schema for a board ID.

Swagger operation ID: GetSingleColumnSchema.

Parameters:

Name	Type	Description	Default
board_id	Optional[str]	Specify the ID of a monday.com board.	None
column_id	Optional[str]	Specify the ID of a monday.com column.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_column_names_schema_for_webhook async

get_column_names_schema_for_webhook(*, board_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get column names for a board ID for a webhook

This operation gets the column names for a board ID for a webhook (includes itemId).

Swagger operation ID: GetColumnNamesSchemaForWebhook.

Parameters:

Name	Type	Description	Default
board_id	Optional[str]	Specify the ID of a monday.com board.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_schema_for_get_items_action async

get_schema_for_get_items_action(*, board_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get column names for a board ID for a webhook

This operation gets the schema for the GetItems action.

Swagger operation ID: GetSchemaForGetItemsAction.

Parameters:

Name	Type	Description	Default
board_id	Optional[str]	Specify the ID of a monday.com board.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_column_names_schema_for_update_webhook async

get_column_names_schema_for_update_webhook(*, board_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get column names for a board ID for an update webhook

This operation gets the column names for a board ID for a webhook (includes itemId).

Swagger operation ID: GetColumnNamesSchemaForUpdateWebhook.

Parameters:

Name	Type	Description	Default
board_id	Optional[str]	Specify the ID of a monday.com board.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_subitem_column_names async

get_subitem_column_names(parent_board_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get subitem column names

Gets subitem column names in monday.com given a board ID.

Swagger operation ID: GetSubitemColumnNames.

Parameters:

Name	Type	Description	Default
parent_board_id	str	Specify the ID of the monday.com parent board.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_subitem_schema async

get_subitem_schema(parent_board_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get subitem column names

Gets subitem schema in monday.com given a board ID.

Swagger operation ID: GetSubitemSchema.

Parameters:

Name	Type	Description	Default
parent_board_id	str	Specify the ID of the monday.com parent board.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_column_names_schema_for_item_name_change_webhook async

get_column_names_schema_for_item_name_change_webhook(*, board_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get column names schema for column changes

This operation gets the column names for a board ID for a webhook when the item's name changes.

Swagger operation ID: GetColumnNamesSchemaForItemNameChangeWebhook.

Parameters:

Name	Type	Description	Default
board_id	Optional[str]	Specify the ID of a monday.com board.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_column_names_schema_for_subitem_name_change_webhook async

get_column_names_schema_for_subitem_name_change_webhook(parent_board_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get column names schema for column changes

This operation gets the column names for a board ID for a webhook when the subitem's name changes.

Swagger operation ID: GetColumnNamesSchemaForSubitemNameChangeWebhook.

Parameters:

Name	Type	Description	Default
parent_board_id	str	Specify the ID of the monday.com parent board.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_column_names_schema_for_column_changes_webhook async

get_column_names_schema_for_column_changes_webhook(*, board_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get column names schema for column changes

This operation gets the column names for a board ID for a webhook (includes itemId).

Swagger operation ID: GetColumnNamesSchemaForColumnChangesWebhook.

Parameters:

Name	Type	Description	Default
board_id	Optional[str]	Specify the ID of a monday.com board.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.