Skip to main content

monday-api-python-sdk

A Python SDK for interacting with Monday"s GraphQL API.

Table of Contents

Installation

To install the SDK, use pip:

pip install monday-api-python-sdk

Authentication

To use the SDK, you need to authenticate with your Monday API token:

from monday_sdk import MondayClient, MondayApiResponse, Board

client = MondayClient(token="your_token")

Examples

Here are some examples of how to use the SDK:

Example 1: Create a new item

from monday_sdk import MondayClient

client = MondayClient(token="your_token")

column_values = {
    "status_column_id": "In Progress",  # Replace with your actual status column ID and value
    "date_column_id": "2025-01-06",    # Replace with your actual date column ID and date (YYYY-MM-DD format)
    "text_column_id": "Important task" # Replace with your actual text column ID and value
}

item = client.items.create_item(
    board_id="your_board_id", 
    group_id="your_group_id", 
    item_name="New Item", 
    column_values=column_values
)

print(item)

Example 2: Create an Update and Update Column Values

from monday_sdk import MondayClient, StatusColumnValue, DateColumnValue

client = MondayClient(token="your_token")

# Create an update for an item
update_response = client.updates.create_update(
    item_id="your_item_id",
    update_value="This is a new update message for the item."
)

# Change a status column value
status_response = client.items.change_status_column_value(
    board_id="your_board_id",
    item_id="your_item_id",
    column_id="status_column_id",  # Replace with the actual column ID
    value="Done"  # Replace with the desired status value
)
print(f"Status column updated: {status_response}")

# Change a date column value
date_response = client.items.change_date_column_value(
    board_id="your_board_id",
    item_id="your_item_id",
    column_id="date_column_id",
    timestamp="2025-01-06" 
)

Response Types

The SDK provides structured types to help you work with API responses more effectively. These types allow you to easily access and manipulate the data returned by the API.

Available Types

  • MondayApiResponse: Represents the full response from a Monday API query, including data and account information.
  • Data: Holds the core data returned from the API, such as boards, items, and complexity details.
  • Board: Represents a Monday board, including items, updates, and activity logs.
  • Item: Represents an item on a board, including its details and associated subitems.
  • Column, ColumnValue: Represents columns and their values for an item.
  • Group: Represents a group within a board.
  • User: Represents a user associated with an update or activity log.
  • Update: Represents an update on an item.
  • ActivityLog: Represents an activity log entry on a board.
  • ItemsPage: Represents a paginated collection of items.

Example Usage

Here is an example of how to use these types with the SDK to deserialize API responses:

from monday_sdk import MondayClient

client = MondayClient(token="your_token")
items = client.boards.fetch_all_items_by_board_id(board_id="your_board_id")
first_item_name = items[0].name
print(f"First item name: {first_item_name}")

By using these types, you can ensure type safety and better code completion support in your IDE, making your work with the Monday API more efficient and error-free.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

monday_api_python_sdk-1.6.8.tar.gz (28.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

monday_api_python_sdk-1.6.8-py3-none-any.whl (33.0 kB view details)

Uploaded Python 3

File details

Details for the file monday_api_python_sdk-1.6.8.tar.gz.

File metadata

  • Download URL: monday_api_python_sdk-1.6.8.tar.gz
  • Upload date:
  • Size: 28.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for monday_api_python_sdk-1.6.8.tar.gz
Algorithm Hash digest
SHA256 7967fc99804a7bfcac8745ade554843ebc851eb2b8e194aa5288015ca6d8a85a
MD5 6b925d125a812b6a45c2ac77123e1d1a
BLAKE2b-256 6a56f093a3ed7db484ded22f4c495c7c167c42cd1971e0225672709b335e2492

See more details on using hashes here.

Provenance

The following attestation bundles were made for monday_api_python_sdk-1.6.8.tar.gz:

Publisher: pypa-publish.yml on mondaycom/monday-api-python-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file monday_api_python_sdk-1.6.8-py3-none-any.whl.

File metadata

File hashes

Hashes for monday_api_python_sdk-1.6.8-py3-none-any.whl
Algorithm Hash digest
SHA256 db5b57afa61f2b21c7c4b4e502fd764f3eff9c53618327e60384f51d7c291890
MD5 05a7b50bf90c7bffbddb26e4e82a9f6b
BLAKE2b-256 cef7d2a5e81726fc75304f6ea444caa10faae576c69ab5a1b8ae5946b9971b67

See more details on using hashes here.

Provenance

The following attestation bundles were made for monday_api_python_sdk-1.6.8-py3-none-any.whl:

Publisher: pypa-publish.yml on mondaycom/monday-api-python-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

1.6.8 This release

2 files

1.6.7

2 files

1.6.6

2 files

1.6.5

2 files

1.6.3

2 files

1.6.0

2 files

1.5.4

2 files

1.5.3

2 files

1.5.2

2 files

1.5.1

2 files

1.5.0

2 files

1.4.9

2 files

1.4.8

2 files

1.4.7

2 files

1.4.6

2 files

1.4.5

2 files

1.4.4

2 files

1.4.3

2 files

1.4.2

2 files

1.4.1

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

1.3.0

2 files

1.2.3

2 files

1.1.3

2 files

1.1.1

2 files

1.1.0

2 files

1.0.1

2 files

0.9.3

2 files

0.9.2

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page