zammad_py

What it is and what it does

zammad_py is a Python wrapper around the Zammad helpdesk REST API. It abstracts HTTP calls into object-oriented resource classes (User, Ticket, Organization, Group, Role, Link, TicketArticle, KnowledgeBases, and others), each supporting standard methods like .all(), .find(), .create(), .update(), and .destroy(). Most resources also support pagination via .next_page() and .prev_page(), and search via .search(). The client handles authentication via username and password, and supports acting on behalf of another user through the on_behalf_of attribute or context manager.

It is intended for developers building integrations with Zammad—automating ticket creation, querying user and organization data, managing knowledge base content, or building custom workflows. The library depends only on requests for HTTP communication, making it lightweight to install. It targets Python 3.9 and later, is actively maintained, and carries no known security vulnerabilities.

Use it for:

• Automate ticket creation and updates from external systems or event streams.
• Build custom dashboards or reporting tools that query Zammad user, ticket, and organization data.
• Sync user or organization records between Zammad and another database or identity system.
• Manage knowledge base articles and categories programmatically.
• Implement on-behalf-of workflows to perform actions as a different user within Zammad.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Python client library for the Zammad helpdesk API, providing object-oriented access to users, tickets, organizations, and knowledge base resources with standard CRUD operations and pagination.

Yes. The package is actively maintained, has low install friction, carries no known vulnerabilities, and is permissively licensed. Install it if you need to integrate with Zammad from Python; the API surface is straightforward and well-documented. Not worth installing if you do not use Zammad or need only occasional API calls via direct HTTP requests.

Install

zammad-py on PyPI

pip install zammad-py

uv add zammad-py

poetry add zammad-py

Installing zammad_py

Before you install

Low friction install with a single runtime dependency (requests). Actively maintained with recent commits; last release 191 days ago. Supports Python 3.9 through 3.13.

License in practice

MIT license is permissive; you can use this package freely in commercial and private projects with minimal restrictions.

Quickstart

pip install zammad-py

from zammad_py import ZammadAPI

client = ZammadAPI(url='https://zammad.example.org/api/v1/', username='user', password='pass')
users = client.user.all()
for user in users:
    print(user)

Requires a running Zammad instance and valid API credentials (URL, username, password).

Verify before relying

• Whether token/OAuth authentication is supported as an alternative to username/password.
• Rate limiting behavior and retry logic when interacting with the Zammad API.
• Support for custom fields or extensions beyond the documented resource types.

Package facts

Evidence: zammad_py-3.2.1-py3-none-any.whl

Tags

More WWW/HTTP packages