{"id":46848,"library":"zammad-py","title":"Zammad Python API Client","description":"Python client for the Zammad helpdesk/ticketing system API. Current version 3.2.1, supports Python >=3.9, released under MIT license. Active development with regular releases.","status":"active","version":"3.2.1","language":"python","source_language":"en","source_url":"https://github.com/joeirimpan/zammad_py","tags":["zammad","api-client","helpdesk","ticketing"],"install":[{"cmd":"pip install zammad-py","lang":"bash","label":"pip install"}],"dependencies":[{"reason":"HTTP library for API calls","package":"requests","optional":false}],"imports":[{"note":"Correct main class import","symbol":"ZammadAPI","correct":"from zammad_py import ZammadAPI"},{"note":"Resource class for tickets","symbol":"Ticket","correct":"from zammad_py import Ticket"},{"note":"Resource class for organizations","symbol":"Organization","correct":"from zammad_py import Organization"},{"note":"Resource class for users","symbol":"User","correct":"from zammad_py import User"}],"quickstart":{"code":"from zammad_py import ZammadAPI\n\nclient = ZammadAPI(\n    url='https://your-zammad-instance.com',\n    username='your_username',\n    password='your_password'\n)\n# Example: fetch tickettickets = client.ticket.all()\nprint(tickets)\n\n# Create a ticket\nnew_ticket = client.ticket.create(\n    title='Test Ticket',\n    group='Users',\n    customer='customer@example.com',\n    article={\n        'subject': 'Test',\n        'body': 'Hello, this is a test ticket.',\n        'type': 'note',\n        'internal': False\n    }\n)\nprint(new_ticket)","lang":"python","description":"Initialize client with URL and credentials, then use resource objects like `client.ticket`."},"warnings":[{"fix":"Use `ZammadAPI(url, username='...', password='...')` or set `http_token=True` for token auth.","message":"Version 3.x changed authentication: `ZammadAPI` no longer accepts `token` parameter without `http_token` flag. Use `http_token=True` or switch to password auth.","severity":"breaking","affected_versions":">=3.0.0"},{"fix":"Use `client.ticket.all(query: {'title__contains': 'test'})` instead of `search`.","message":"The `search` method on resources uses Elasticsearch-like query syntax; simple `all()` with filters is preferred.","severity":"deprecated","affected_versions":">=2.0.0"},{"fix":"Always include `'type': 'note'` or `'type': 'email'` in article dict.","message":"When creating a ticket, the `article` dictionary must include `type` field. Common mistake: omitting `type` or using incorrect values like 'note' vs 'email'.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"search_vec":"'3.2.1':15 '3.9':18 'activ':23 'api':3,12,30 'api-cli':29 'client':4,6,31 'current':13 'develop':24 'helpdesk':32 'helpdesk/ticketing':10 'licens':22 'mit':21 'python':2,5,17 'regular':26 'releas':19,27 'support':16 'system':11 'ticket':33 'version':14 'zammad':1,9,28","created_at":"2026-06-07T13:01:55.469876+00:00","updated_at":"2026-06-07T13:01:55.469876+00:00","problems":[{"fix":"Ensure all mandatory fields are provided: group, customer, title, and article with body.","cause":"Missing required fields when creating a ticket or resource.","error":"zammad_py.exceptions.ZammadError: HTTP 422 - Unprocessable Entity"},{"fix":"Verify username/password or token. For token auth, pass `http_token=True` to ZammadAPI.","cause":"Invalid credentials or token not properly configured.","error":"zammad_py.exceptions.ZammadError: HTTP 401 - Unauthorized"},{"fix":"Check that you are using the latest version and call `client.ticket` (lowercase).","cause":"Old import pattern using `from zammad_py import ZammadAPI` but using wrong client instantiation or outdated version.","error":"AttributeError: 'ZammadAPI' object has no attribute 'ticket'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/joeirimpan/zammad_py","github":"https://github.com/joeirimpan/zammad_py.git","docs":null,"changelog":null,"pypi":null,"npm":null,"openapi_spec":null,"status_page":null,"smithery":null,"categories":["devops"],"base_url":null,"auth_type":null,"provenance":{"verified_status":"passing","verified_at":"2026-06-29","last_verified":"2026-06-29","next_check":"2026-07-29","install_tag":null}}