Zammad

https://docs.zammad.org/en/latest/
Admin
Zammad is an open-source customer support and ticketing system that provides web-based helpdesk...
Tokens:176,216
Snippets:993
Trust Score:9.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install required tools on CentOS and RHEL

Source: https://docs.zammad.org/en/latest/install/package.html

Install curl and the EPEL repository.

```bash
$ sudo dnf install curl epel-release
```

--------------------------------

### Start and Enable Elasticsearch

Source: https://docs.zammad.org/en/latest/install/elasticsearch/install-elasticsearch-9.html

Command to enable and start the Elasticsearch service immediately.

```bash
$ sudo systemctl enable elasticsearch.service --now
```

--------------------------------

### Redis Sentinel Setup Examples

Source: https://docs.zammad.org/en/latest/appendix/redis.html

Configure Zammad to connect to a Redis Sentinel cluster. REDIS_SENTINELS is mandatory, specifying comma-separated IPs/URLs for sentinels. Optional variables include sentinel name, username, password, and Redis username/password.

```bash
REDIS_SENTINELS=sentinel1.example.com:26380,sentinel2.example.com
```

```bash
REDIS_SENTINEL_NAME=mymaster
```

```bash
REDIS_SENTINEL_USERNAME=sentinel_user
```

```bash
REDIS_SENTINEL_PASSWORD=sentinel_password
```

```bash
REDIS_USERNAME=redis_user
```

```bash
REDIS_PASSWORD=redis_password
```

--------------------------------

### User Show Response Example

Source: https://docs.zammad.org/en/latest/api/user.html

Example of a successful HTTP 200 OK response when retrieving user information.

```json
{
   "id": 11,
   "organization_id": null,
   "login": "olivia@example.com",
   "firstname": "Olivia",
   "lastname": "Ross",
   "email": "olivia@example.com",
   "image": "b6f7a2d56544bb471eb3a3c238c7d964",
   "image_source": null,
   "web": "",
   "phone": "0044 20 1234 5678",
   "fax": "",
   "mobile": "",
   "department": null,
   "street": "",
   "zip": "",
   "city": "",
   "country": "",
   "address": "Westminster\nLondon SW1A 0AA",
   "vip": false,
   "verified": false,
   "active": true,
   "note": "",
   "last_login": null,
   "source": null,
   "login_failed": 0,
   "out_of_office": false,
   "out_of_office_start_at": null,
   "out_of_office_end_at": null,
   "out_of_office_replacement_id": null,
   "preferences": {
      "lat": 51.5004439,
      "lng": -0.1265398
   },
   "updated_by_id": 1,
   "created_by_id": 1,
   "created_at": "2025-06-24T10:46:57.114Z",
   "updated_at": "2025-06-24T10:46:57.889Z",
   "role_ids": [
      3
   ],
   "two_factor_preference_ids": [],
   "organization_ids": [],
   "authorization_ids": [],
   "overview_sorting_ids": [],
   "group_ids": {}
}
```

--------------------------------

### Check Zammad Installation Status

Source: https://docs.zammad.org/en/latest/appendix/backup-and-restore/migrate-hosts.html

Example output indicating that Zammad is already at the latest version, which may necessitate a forced reinstall.

```text
Reading package lists... Done
Building dependency tree
Reading state information... Done
zammad is already the newest version (x.x.x-xxxxxx.xxxxxx.xxx).
0 upgraded, 0 newly installed, 0 to remove and 0 not upgraded.
```

--------------------------------

### Migration Job State Examples

Source: https://docs.zammad.org/en/latest/migration/freshdesk.html

Examples of ImportJob output showing different stages of the migration process.

```ruby
#<ImportJob:0x0000000008274310
   id: 1,
   name: "Import::Freshdesk",
   dry_run: false,
   payload: {},
   result:
   {"Organizations"=>
      {"skipped"=>0,
      "created"=>0,
      "updated"=>0,
      "unchanged"=>0,
      "failed"=>0,
      "deactivated"=>0,
      "sum"=>0,
      "total"=>100}},
   started_at: Mon, 03 Jan 2022 18:41:51 UTC +00:00,
   finished_at: nil,
   created_at: Mon, 03 Jan 2022 18:41:16 UTC +00:00,
   updated_at: Mon, 03 Jan 2022 18:43:32 UTC +00:00>
```

```ruby
#<ImportJob:0x000055ba3d9dbbb8
   id: 1,
   name: "Import::Freshdesk",
   dry_run: false,
   payload: {},
   result:
   {"Groups"=>
      {"skipped"=>0,
      "created"=>3,
      "updated"=>0,
      "unchanged"=>0,
      "failed"=>0,
      "deactivated"=>0,
      "sum"=>3,
      "total"=>3},
   "Organizations"=>
      {"skipped"=>0,
      "created"=>193,
      "updated"=>1,
      "unchanged"=>0,
      "failed"=>0,
      "deactivated"=>0,
      "sum"=>194,
      "total"=>194},
   "Users"=>
      {"skipped"=>0,
      "created"=>3352,
      "updated"=>0,
      "unchanged"=>0,
      "failed"=>0,
      "deactivated"=>0,
      "sum"=>3352,
      "total"=>3352},
   "Tickets"=>
      {"skipped"=>0,
      "created"=>987,
      "updated"=>0,
      "unchanged"=>0,
      "failed"=>0,
      "deactivated"=>0,
      "sum"=>987,
      "total"=>1000}},
   started_at: Tue, 04 Jan 2022 11:37:38 UTC +00:00,
   finished_at: nil,
   created_at: Tue, 04 Jan 2022 11:37:36 UTC +00:00,
   updated_at: Tue, 04 Jan 2022 12:12:52 UTC +00:00>
```

```ruby
#<ImportJob:0x0000561da0def350
   id: 1,
   name: "Import::Freshdesk",
   dry_run: false,
   payload: {},
   result:
   {"Groups"=>
      {"skipped"=>0,
      "created"=>3,
      "updated"=>0,
      "unchanged"=>0,
      "failed"=>0,
      "deactivated"=>0,
      "sum"=>3,
      "total"=>3},
   "Organizations"=>
      {"skipped"=>0,
      "created"=>193,
      "updated"=>1,
      "unchanged"=>0,
      "failed"=>0,
      "deactivated"=>0,
      "sum"=>194,
      "total"=>194},
   "Users"=>
      {"skipped"=>0,
      "created"=>3352,
      "updated"=>0,
      "unchanged"=>0,
      "failed"=>0,
      "deactivated"=>0,
      "sum"=>3352,
      "total"=>3352},
   "Tickets"=>
      {"skipped"=>0,
      "created"=>4714,
      "updated"=>0,
      "unchanged"=>0,
      "failed"=>1,
      "deactivated"=>0,
      "sum"=>4715,
      "total"=>4715}},
   started_at: Tue, 04 Jan 2022 11:37:38 UTC +00:00,
   finished_at: Tue, 04 Jan 2022 14:30:57 UTC +00:00,
   created_at: Tue, 04 Jan 2022 11:37:36 UTC +00:00,
   updated_at: Tue, 04 Jan 2022 14:30:57 UTC +00:00>
```

--------------------------------

### Install pgloader on OpenSUSE/SLES

Source: https://docs.zammad.org/en/latest/appendix/migrate-to-postgresql.html

Installs the pgloader utility on OpenSUSE/SLES systems.

```bash
$ sudo zypper refresh

```

```bash
$ sudo zypper install pgloader

```

--------------------------------

### Start Zammad Service

Source: https://docs.zammad.org/en/latest/install/host-upgrade-repo-migration.html

Command to start the Zammad service using systemctl.

```bash
$ sudo systemctl start zammad
```

--------------------------------

### User Creation Response Example

Source: https://docs.zammad.org/en/latest/api/user.html

Example of a successful HTTP 201 Created response after creating a new user.

```json
{
   "id": 13,
   "organization_id": 1,
   "login": "jdoe",
   "firstname": "Jane",
   "lastname": "Doe",
   "email": "jdoe@example.com",
   "image": null,
   "image_source": null,
   "web": "",
   "phone": "",
   "fax": "",
   "mobile": "",
   "department": null,
   "street": "",
   "zip": "",
   "city": "",
   "country": "",
   "address": null,
   "vip": false,
   "verified": false,
   "active": true,
   "note": "",
   "last_login": null,
   "source": null,
   "login_failed": 0,
   "out_of_office": false,
   "out_of_office_start_at": null,
   "out_of_office_end_at": null,
   "out_of_office_replacement_id": null,
   "preferences": {
      "notification_config": {
         "matrix": {
            "create": {
               "criteria": {
                  "owned_by_me": true,
                  "owned_by_nobody": true,
                  "subscribed": true,
                  "no": false
               },
               "channel": {
                  "email": true,
                  "online": true
               }
            },
            "update": {
               "criteria": {
                  "owned_by_me": true,
                  "owned_by_nobody": true,
                  "subscribed": true,
                  "no": false
               },
               "channel": {
                  "email": true,
                  "online": true
               }
            },
            "reminder_reached": {
               "criteria": {
                  "owned_by_me": true,
                  "owned_by_nobody": false,
                  "subscribed": false,
                  "no": false
               },
               "channel": {
                  "email": true,
                  "online": true
               }
            },
            "escalation": {
               "criteria": {
                  "owned_by_me": true,
                  "owned_by_nobody": false,
                  "subscribed": false,
                  "no": false
               },
               "channel": {
                  "email": true,
                  "online": true
               }
            }
            }
      },
      "locale": "de-de"
   },
   "updated_by_id": 3,
   "created_by_id": 3,
   "created_at": "2025-06-30T12:14:48.194Z",
   "updated_at": "2025-06-30T12:14:48.178Z",
   "role_ids": [
      3,
      2
   ],
   "two_factor_preference_ids": [],
   "organization_ids": [],
   "authorization_ids": [],
   "overview_sorting_ids": [],
   "group_ids": {}
}
```

--------------------------------

### Install required tools on Ubuntu and Debian

Source: https://docs.zammad.org/en/latest/install/package.html

Install essential packages for repository management and secure communication.

```bash
$ sudo apt install curl apt-transport-https gnupg
```

--------------------------------

### Start Migration Job

Source: https://docs.zammad.org/en/latest/migration/kayako.html

Initialize and queue the Kayako import job.

```ruby
>> job = ImportJob.create(name: 'Import::Kayako')
```

```ruby
>> AsyncImportJob.perform_later(job)
```

--------------------------------

### Install Apache Dependencies (OpenSUSE)

Source: https://docs.zammad.org/en/latest/appendix/single-sign-on.html

Refresh repositories and install the Kerberos client and Apache authentication module for Kerberos on OpenSUSE systems.

```bash
sudo zypper ref
```

```bash
sudo zypper install krb5-client apache2-mod_auth_kerb
```

--------------------------------

### Pagination Example

Source: https://docs.zammad.org/en/latest/api/intro.html

Demonstrates how to use 'page' and 'per_page' parameters for pagination.

```APIDOC
## GET /api/v1/tickets/search?page=1&per_page=5

### Description
Retrieves a specific page of search results with a defined number of items per page.

### Method
GET

### Endpoint
/api/v1/tickets/search

### Parameters
#### Query Parameters
- **page** (integer) - Required - The page number to retrieve (e.g., 1 for the first page).
- **per_page** (integer) - Required - The number of results to return per page (e.g., 5).

### Request Example
```
GET /api/v1/tickets/search?page=1&per_page=5
```

### Response
#### Success Response (200)
An array of ticket objects for the specified page.

#### Response Example
```json
[
   {
      "id": 1,
      "group_id": 1,
      "priority_id": 2,
      "state_id": 1,
      "organization_id": 1,
      "number": "20001",
      "title": "Welcome to Zammad!",
      "owner_id": 1,
      "customer_id": 2,
      "note": null,
      "first_response_at": null,
      "first_response_escalation_at": null,
      "first_response_in_min": null,
      "first_response_diff_in_min": null,
      "close_at": null,
      "close_escalation_at": null,
      "close_in_min": null,
      "close_diff_in_min": null,
      "update_escalation_at": null,
      "update_in_min": null,
      "update_diff_in_min": null,
      "last_close_at": null,
      "last_contact_at": "2025-01-14T07:45:08.726Z",
      "last_contact_agent_at": null,
      "last_contact_customer_at": "2025-01-14T07:45:08.726Z",
      "last_owner_update_at": null,
      "create_article_type_id": 5,
      "create_article_sender_id": 2,
      "article_count": 1,
      "escalation_at": null,
      "pending_time": null,
      "type": null,
      "time_unit": null,
      "preferences": {},
      "updated_by_id": 2,
      "created_by_id": 2,
      "created_at": "2025-01-14T07:45:08.681Z",
      "updated_at": "2025-01-14T07:45:08.790Z",
      "checklist_id": null,
      "referencing_checklist_ids": [],
      "article_ids": [
         1
      ],
      "ticket_time_accounting_ids": []
   }
]
```
```

--------------------------------

### Start Migration Job

Source: https://docs.zammad.org/en/latest/migration/freshdesk.html

Initialize and queue the import job.

```ruby
>> job = ImportJob.create(name: 'Import::Freshdesk')
```

```ruby
>> AsyncImportJob.perform_later(job)
```

--------------------------------

### Install pgloader on CentOS

Source: https://docs.zammad.org/en/latest/appendix/migrate-to-postgresql.html

Installs the pgloader utility on CentOS systems.

```bash
$ sudo dnf install -y pgloader

```

--------------------------------

### Install imlib2 on openSUSE/SLES

Source: https://docs.zammad.org/en/latest/prerequisites/software.html

Use zypper to install the imlib2 package on openSUSE Leap and SLES.

```bash
$ sudo zypper install imlib2

```

--------------------------------

### Install PostgreSQL on CentOS

Source: https://docs.zammad.org/en/latest/appendix/migrate-to-postgresql.html

Installs PostgreSQL server and its contrib package on CentOS systems. Initializes the database cluster and starts/enables the service.

```bash
$ sudo dnf install postgresql-server postgresql-contrib

```

```bash
$ sudo postgresql-setup initdb

```

```bash
$ sudo systemctl start postgresql

```

```bash
$ sudo systemctl enable postgresql

```

--------------------------------

### Install epel-release on CentOS/RHEL

Source: https://docs.zammad.org/en/latest/prerequisites/software.html

Install the EPEL repository to access additional packages on CentOS and RHEL.

```bash
$ sudo dnf install epel-release

```

--------------------------------

### Install PostgreSQL on OpenSUSE/SLES

Source: https://docs.zammad.org/en/latest/appendix/migrate-to-postgresql.html

Installs PostgreSQL, its server, and contrib packages on OpenSUSE/SLES. Includes an additional package for OpenSUSE 15 and starts/enables the service.

```bash
$ sudo zypper refresh

```

```bash
$ sudo zypper install postgresql postgresql-server postgresql-contrib

```

```bash
$ sudo zypper install postgresql-server-devel

```

```bash
$ sudo systemctl start postgresql

```

```bash
$ sudo systemctl enable postgresql

```

--------------------------------

### Install imlib2 on CentOS/RHEL

Source: https://docs.zammad.org/en/latest/prerequisites/software.html

Use dnf to install the imlib2 package on CentOS and RHEL systems.

```bash
$ sudo dnf install imlib2

```

--------------------------------

### Install Elasticsearch

Source: https://docs.zammad.org/en/latest/install/elasticsearch/install-elasticsearch-9.html

Commands to install the Elasticsearch package using the system package manager.

```bash
$ sudo apt update && sudo apt install elasticsearch
```

```bash
$ sudo zypper modifyrepo --enable elasticsearch && sudo zypper install elasticsearch
```

```bash
$ sudo dnf install --enablerepo=elasticsearch elasticsearch
```

--------------------------------

### Install libimlib2 on Ubuntu/Debian

Source: https://docs.zammad.org/en/latest/prerequisites/software.html

Use this command to install the libimlib2 package on Ubuntu and Debian systems.

```bash
$ sudo apt install libimlib2

```

--------------------------------

### Example Ticket Search Response (Full)

Source: https://docs.zammad.org/en/latest/api/intro.html

This is a partial example of a response using the `full=true` parameter. It includes `record_ids` and an `assets` object, which contains detailed information about related entities. Note that the full response can be very large.

```json
{
   "record_ids": [
      1
   ],
   "assets": {
      "Ticket": {
         "1": {

```

--------------------------------

### Install Apache Dependencies (CentOS)

Source: https://docs.zammad.org/en/latest/appendix/single-sign-on.html

Install Kerberos workstation tools and the Apache Kerberos authentication module on CentOS systems.

```bash
sudo dnf install krb5-workstation mod_auth_kerb
```

--------------------------------

### Install pgloader on Ubuntu/Debian

Source: https://docs.zammad.org/en/latest/appendix/migrate-to-postgresql.html

Installs the pgloader utility on Ubuntu or Debian-based systems. Ensure your package list is updated first.

```bash
$ sudo apt update

```

```bash
$ sudo apt install pgloader

```

--------------------------------

### User API Response Example

Source: https://docs.zammad.org/en/latest/api/user.html

This is an example of a successful HTTP 200 OK response when listing users. It includes detailed user information.

```json
[
   {
      "id": 1,
      "organization_id": null,
      "login": "-",
      "firstname": "-",
      "lastname": "",
      "email": "",
      "image": null,
      "image_source": null,
      "web": "",
      "phone": "",
      "fax": "",
      "mobile": "",
      "department": "",
      "street": "",
      "zip": "",
      "city": "",
      "country": "",
      "address": "",
      "vip": false,
      "verified": false,
      "active": false,
      "note": "",
      "last_login": null,
      "source": null,
      "login_failed": 0,
      "out_of_office": false,
      "out_of_office_start_at": null,
      "out_of_office_end_at": null,
      "out_of_office_replacement_id": null,
      "preferences": {},
      "updated_by_id": 1,
      "created_by_id": 1,
      "created_at": "2025-06-24T10:46:31.114Z",
      "updated_at": "2025-06-24T10:46:31.114Z",
      "role_ids": [],
      "two_factor_preference_ids": [],
      "organization_ids": [],
      "authorization_ids": [],
      "overview_sorting_ids": [],
      "group_ids": {}
   },
   {
      "id": 2,
      "organization_id": 1,
      "login": "nicole.braun@zammad.org",
      "firstname": "Nicole",
      "lastname": "Braun",
      "email": "nicole.braun@zammad.org",
      "image": null,
      "image_source": null,
      "web": "",
      "phone": "",
      "fax": "",
      "mobile": "",
      "department": "",
      "street": "",
      "zip": "",
      "city": "",
      "country": "",
      "address": "",
      "vip": false,
      "verified": false,
      "active": true,
      "note": "",
      "last_login": null,
      "source": null,
      "login_failed": 0,
      "out_of_office": false,
      "out_of_office_start_at": null,
      "out_of_office_end_at": null,
      "out_of_office_replacement_id": null,
      "preferences": {
         "tickets_closed": 0,
         "tickets_open": 1
      },
      "updated_by_id": 2,
      "created_by_id": 1,
      "created_at": "2025-06-24T10:46:34.110Z",
      "updated_at": "2025-06-24T10:55:36.632Z",
      "role_ids": [
         3
      ],
      "two_factor_preference_ids": [],
      "organization_ids": [],
      "authorization_ids": [],
      "overview_sorting_ids": [],
      "group_ids": {}
   },
   {
      "login_failed": 0,
      "last_login": "2025-06-30T11:45:19.503Z",
      "updated_by_id": 1,
      "id": 3,
      "organization_id": 2,
      "login": "chris@chrispresso.com",
      "firstname": "Christopher",
      "lastname": "Miller",
      "email": "chris@chrispresso.com",
      "image": "7a6a0d1d94ad2037153cf3a6c1b49a53",
      "image_source": null,
      "web": "",
      "phone": "",
      "fax": "",
      "mobile": "",
      "department": null,
      "street": "",
      "zip": "",
      "city": "",
      "country": "",
      "address": null,
      "vip": false,
      "verified": false,
      "active": true,
      "note": "",
      "source": null,
      "out_of_office": false,
      "out_of_office_start_at": null,
      "out_of_office_end_at": null,
      "out_of_office_replacement_id": null,
      "preferences": {
         "locale": "de-de",
         "notification_config": {
            "matrix": {
               "create": {
                  "criteria": {
                  "owned_by_me": true,
                  "owned_by_nobody": true,
                  "subscribed": true,
                  "no": false
                  },
                  "channel": {
                  "email": true,
                  "online": true
                  }
               },
               "update": {
                  "criteria": {
                  "owned_by_me": true,
                  "owned_by_nobody": true,
                  "subscribed": true,
                  "no": false
                  },
                  "channel": {
                  "email": true,
                  "online": true
                  }
               },
               "reminder_reached": {
                  "criteria": {
                  "owned_by_me": true,
                  "owned_by_nobody": false,
                  "subscribed": false,
                  "no": false
                  },
                  "channel": {
                  "email": true,
                  "online": true
                  }
               },
               "escalation": {
                  "criteria": {
                  "owned_by_me": true,
                  "owned_by_nobody": false,
                  "subscribed": false,
                  "no": false
                  },
                  "channel": {
                  "email": true,
                  "online": true
                  }
               }
            }
         },
         "intro": true,
         "keyboard_shortcuts_clues": true,
         "theme": "light"
      },
      "created_by_id": 1
   }
]
```

--------------------------------

### Example Backup Output

Source: https://docs.zammad.org/en/latest/appendix/backup-and-restore/backup.html

The expected console output when the backup process runs successfully.

```text
# Zammad backup started - Fri Jan 21 17:53:44 CET 2022!

creating file backup...
 ... as full dump
creating postgresql backup...
Ensuring dump permissions ...

# Zammad backuped successfully - Fri Jan 21 17:53:57 CET 2022!
```

--------------------------------

### Group and User JSON Data Structures

Source: https://docs.zammad.org/en/latest/api/checklist/checklists.html

Example JSON objects representing Group configurations and User profiles as stored in the system.

```json
"assignment_timeout": null,
            "follow_up_possible": "yes",
            "reopen_time_in_days": null,
            "follow_up_assignment": true,
            "active": true,
            "shared_drafts": true,
            "note": "Standard Group/Pool for Tickets.",
            "updated_by_id": 1,
            "created_by_id": 1,
            "created_at": "2024-11-05T14:04:59.574Z",
            "updated_at": "2024-11-05T14:05:09.464Z",
            "user_ids": [
               4,
               3,
               5
            ]
         },
         "2": {
            "id": 2,
            "signature_id": null,
            "email_address_id": null,
            "name": "2nd Level",
            "name_last": "2nd Level",
            "parent_id": null,
            "assignment_timeout": null,
            "follow_up_possible": "yes",
            "reopen_time_in_days": null,
            "follow_up_assignment": true,
            "active": true,
            "shared_drafts": true,
            "note": null,
            "updated_by_id": 1,
            "created_by_id": 1,
            "created_at": "2024-11-05T14:05:08.581Z",
            "updated_at": "2024-11-05T14:05:09.477Z",
            "user_ids": [
               4,
               3,
               5
            ]
         },
         "3": {
            "id": 3,
            "signature_id": null,
            "email_address_id": null,
            "name": "Service Desk",
            "name_last": "Service Desk",
            "parent_id": null,
            "assignment_timeout": null,
            "follow_up_possible": "yes",
            "reopen_time_in_days": null,
            "follow_up_assignment": true,
            "active": true,
            "shared_drafts": true,
            "note": null,
            "updated_by_id": 1,
            "created_by_id": 1,
            "created_at": "2024-11-05T14:05:08.610Z",
            "updated_at": "2024-11-05T14:05:09.485Z",
            "user_ids": [
               4,
               3,
               5
            ]
         }
      },
      "User": {
         "1": {
            "id": 1,
            "organization_id": null,
            "login": "-",
            "firstname": "-",
            "lastname": "",
            "email": "",
            "image": null,
            "image_source": null,
            "web": "",
            "phone": "",
            "fax": "",
            "mobile": "",
            "department": "",
            "street": "",
            "zip": "",
            "city": "",
            "country": "",
            "address": "",
            "vip": false,
            "verified": false,
            "active": false,
            "note": "",
            "last_login": null,
            "source": null,
            "login_failed": 0,
            "out_of_office": false,
            "out_of_office_start_at": null,
            "out_of_office_end_at": null,
            "out_of_office_replacement_id": null,
            "preferences": {},
            "updated_by_id": 1,
            "created_by_id": 1,
            "created_at": "2024-11-05T14:04:58.476Z",
            "updated_at": "2024-11-05T14:04:58.476Z",
            "role_ids": [],
            "two_factor_preference_ids": [],
            "organization_ids": [],
            "authorization_ids": [],
            "overview_sorting_ids": [],
            "group_ids": {}
         },
         "6": {
            "id": 6,
            "organization_id": 3,
            "login": "anna@example.com",
            "firstname": "Anna",
            "lastname": "Lopez",
            "email": "anna@example.com",
            "image": "4b1cb1fae2e608ffa72099774e1f57ad",
            "image_source": null,
            "web": "",
            "phone": "415-123-5858",
            "fax": "",
            "mobile": "",
            "department": null,
            "street": "",
            "zip": "",
            "city": "",
            "country": "",
            "address": "Golden Gate Bridge\nSan Francisco, CA 94129",
            "vip": false,
            "verified": false,
            "active": true,
            "note": "likes espresso romano - recommended espresso con panna",
            "last_login": null,
            "source": null,
            "login_failed": 0,
            "out_of_office": false,
            "out_of_office_start_at": null,
            "out_of_office_end_at": null,
            "out_of_office_replacement_id": null,
            "preferences": {
               "lat": 37.8176155,
               "lng": -122.47831227441239,
               "tickets_closed": 2,
               "tickets_open": 1
            },
            "updated_by_id": 3,
            "created_by_id": 1,
            "created_at": "2024-11-05T14:05:09.670Z",
            "updated_at": "2024-11-06T11:57:10.165Z",
            "role_ids": [
               3
            ],
            "two_factor_preference_ids": [],
            "organization_ids": [],
            "authorization_ids": []
```

--------------------------------

### User and Organization JSON Data Structures

Source: https://docs.zammad.org/en/latest/api/checklist/checklists.html

Example JSON objects representing user profiles with notification preferences and organization details.

```json
{
            "id": 5,
            "organization_id": 2,
            "login": "emma@chrispresso.com",
            "firstname": "Emma",
            "lastname": "Taylor",
            "email": "emma@chrispresso.com",
            "image": "b64fef91c29105b4a08a2a69be08eda3",
            "image_source": null,
            "web": "",
            "phone": "",
            "fax": "",
            "mobile": "",
            "department": null,
            "street": "",
            "zip": "",
            "city": "",
            "country": "",
            "address": null,
            "vip": false,
            "verified": false,
            "active": true,
            "note": "",
            "last_login": null,
            "source": null,
            "login_failed": 0,
            "out_of_office": false,
            "out_of_office_start_at": null,
            "out_of_office_end_at": null,
            "out_of_office_replacement_id": null,
            "preferences": {
               "locale": "en-us",
               "notification_config": {
                  "matrix": {
                     "create": {
                        "criteria": {
                           "owned_by_me": true,
                           "owned_by_nobody": true,
                           "subscribed": true,
                           "no": false
                        },
                        "channel": {
                           "email": true,
                           "online": true
                        }
                     },
                     "update": {
                        "criteria": {
                           "owned_by_me": true,
                           "owned_by_nobody": true,
                           "subscribed": true,
                           "no": false
                        },
                        "channel": {
                           "email": true,
                           "online": true
                        }
                     },
                     "reminder_reached": {
                        "criteria": {
                           "owned_by_me": true,
                           "owned_by_nobody": false,
                           "subscribed": false,
                           "no": false
                        },
                        "channel": {
                           "email": true,
                           "online": true
                        }
                     },
                     "escalation": {
                        "criteria": {
                           "owned_by_me": true,
                           "owned_by_nobody": false,
                           "subscribed": false,
                           "no": false
                        },
                        "channel": {
                           "email": true,
                           "online": true
                        }
                     }
                  }
               }
            },
            "updated_by_id": 1,
            "created_by_id": 1,
            "created_at": "2024-11-05T14:05:09.444Z",
            "updated_at": "2024-11-05T14:05:09.565Z",
            "role_ids": [
               2
            ],
            "two_factor_preference_ids": [],
            "organization_ids": [],
            "authorization_ids": [],
            "overview_sorting_ids": [],
            "group_ids": {
               "1": [
                  "full"
               ],
               "2": [
                  "full"
               ],
               "3": [
                  "full"
               ]
            }
         }
```

```json
{
            "id": 3,
            "name": "Awesome Customer Inc.",
            "shared": true,
            "domain": "",
            "domain_assignment": false,
            "active": true,
            "vip": false,
            "note": "Global distributor of communication and security products, electrical and electronic wire &amp; cable.",
            "updated_by_id": 1,
            "created_by_id": 1,
            "created_at": "2024-11-05T14:05:08.651Z",
            "updated_at": "2024-11-05T14:05:08.651Z",
            "member_ids": [
               6,
               7,
               8
```

--------------------------------

### Zammad User and Checklist Data Objects

Source: https://docs.zammad.org/en/latest/api/checklist/checklists.html

Example JSON objects representing user profiles and associated preferences within the Zammad system.

```json
            "overview_sorting_ids": [],
            "group_ids": {}
         },
         "7": {
            "id": 7,
            "organization_id": 3,
            "login": "samuel@example.com",
            "firstname": "Samuel",
            "lastname": "Lee",
            "email": "samuel@example.com",
            "image": "5911d228f3588c36a72d80eb0c1e4d08",
            "image_source": null,
            "web": "",
            "phone": "855-666-7777",
            "fax": "",
            "mobile": "",
            "department": null,
            "street": "",
            "zip": "",
            "city": "",
            "country": "",
            "address": "5201 Blue Lagoon Drive\n8th Floor & 9th Floor\nMiami, FL 33126",
            "vip": false,
            "verified": false,
            "active": true,
            "note": "likes americano, did order two units",
            "last_login": null,
            "source": null,
            "login_failed": 0,
            "out_of_office": false,
            "out_of_office_start_at": null,
            "out_of_office_end_at": null,
            "out_of_office_replacement_id": null,
            "preferences": {
               "tickets_closed": 1,
               "tickets_open": 1
            },
            "updated_by_id": 3,
            "created_by_id": 1,
            "created_at": "2024-11-05T14:05:10.244Z",
            "updated_at": "2024-11-06T13:51:06.168Z",
            "role_ids": [
               3
            ],
            "two_factor_preference_ids": [],
            "organization_ids": [],
            "authorization_ids": [],
            "overview_sorting_ids": [],
            "group_ids": {}
         },
         "8": {
            "id": 8,
            "organization_id": 3,
            "login": "emily@example.com",
            "firstname": "Emily",
            "lastname": "Adams",
            "email": "emily@example.com",
            "image": "99ba64a89f7783c099c304c9b00ff9e8",
            "image_source": null,
            "web": "",
            "phone": "0061 2 1234 7777",
            "fax": "",
            "mobile": "",
            "department": null,
            "street": "",
            "zip": "",
            "city": "",
            "country": "",
            "address": "Bennelong Point\nSydney NSW 2000",
            "vip": false,
            "verified": false,
            "active": true,
            "note": "did order café au lait, ask next time if the flavor was as expected",
            "last_login": null,
            "source": null,
            "login_failed": 0,
            "out_of_office": false,
            "out_of_office_start_at": null,
            "out_of_office_end_at": null,
            "out_of_office_replacement_id": null,
            "preferences": {
               "lat": -33.8275368,
               "lng": 151.0820211
            },
            "updated_by_id": 1,
            "created_by_id": 1,
            "created_at": "2024-11-05T14:05:12.317Z",
            "updated_at": "2024-11-05T14:05:12.858Z",
            "role_ids": [
               3
            ],
            "two_factor_preference_ids": [],
            "organization_ids": [],
            "authorization_ids": [],
            "overview_sorting_ids": [],
            "group_ids": {}
         },
         "3": {
            "id": 3,
            "organization_id": 2,
            "login": "chris@chrispresso.com",
            "firstname": "Christopher",
            "lastname": "Miller",
            "email": "chris@chrispresso.com",
            "image": "7a6a0d1d94ad2037153cf3a6c1b49a53",
            "image_source": null,
            "web": "",
            "phone": "",
            "fax": "",
            "mobile": "",
            "department": null,
            "street": "",
            "zip": "",
            "city": "",
            "country": "",
            "address": null,
            "vip": false,
            "verified": false,
            "active": true,
            "note": "",
            "last_login": "2024-11-06T08:32:10.202Z",
            "source": null,
            "login_failed": 0,
            "out_of_office": false,
            "out_of_office_start_at": null,
            "out_of_office_end_at": null,
            "out_of_office_replacement_id": null,
            "preferences": {
               "locale": "en-us",
               "notification_config": {
                  "matrix": {
                     "create": {
                        "criteria": {
                           "owned_by_me": true,
                           "owned_by_nobody": true,
                           "subscribed": true,
                           "no": false
                        },
                        "channel": {
                           "email": true,
                           "online": true
                        }
                     },
                     "update": {
                        "criteria": {
                           "owned_by_me": true,
```

--------------------------------

### GET /api/v1/checklists/{checklist id}

Source: https://docs.zammad.org/en/latest/api/checklist/checklists.html

Retrieves the details of a specific checklist by its ID. Requires ticket.agent permission.

```APIDOC
## GET /api/v1/checklists/{checklist id}

### Description
Retrieves the details of a specific checklist.

### Method
GET

### Endpoint
/api/v1/checklists/{checklist id}

### Parameters
#### Path Parameters
- **checklist id** (integer) - Required - The ID of the checklist to retrieve.

### Response
#### Success Response (200)
- **name** (string) - Name of the checklist
- **sorted_item_ids** (array) - List of sorted item IDs
- **ticket_id** (integer) - ID of the associated ticket
- **id** (integer) - Checklist ID

#### Response Example
{
   "name": "Return order",
   "sorted_item_ids": ["18", "19", "20", "21"],
   "ticket_id": 4,
   "id": 6
}
```

--------------------------------

### Deploying Zammad with additional scenarios

Source: https://docs.zammad.org/en/latest/install/docker-compose/docker-compose-scenarios.html

Use this command to start the Zammad stack while including one or more scenario configuration files.

```bash
$ docker compose -f docker-compose.yml -f scenarios/{scenario you want to use}.yml up -d
```

--------------------------------

### List Tickets API Response

Source: https://docs.zammad.org/en/latest/api/ticket/index.html

Example JSON response returned by the GET /api/v1/tickets endpoint.

```json
# HTTP-Code 200 Ok

[
   {
      "id": 1,
      "group_id": 1,
      "priority_id": 2,
      "state_id": 1,
      "organization_id": 1,
      "number": "22001",
      "title": "Welcome to Zammad!",
      "owner_id": 1,
      "customer_id": 2,
      "note": null,
      "first_response_at": null,
      "first_response_escalation_at": null,
      "first_response_in_min": null,
      "first_response_diff_in_min": null,
      "close_at": null,
      "close_escalation_at": null,
      "close_in_min": null,
      "close_diff_in_min": null,
      "update_escalation_at": null,
      "update_in_min": null,
      "update_diff_in_min": null,
      "last_contact_at": "2021-11-03T11:51:13.790Z",
      "last_contact_agent_at": null,
      "last_contact_customer_at": "2021-11-03T11:51:13.790Z",
      "last_owner_update_at": null,
      "create_article_type_id": 5,
      "create_article_sender_id": 2,
      "article_count": 1,
      "escalation_at": null,
      "pending_time": null,
      "type": null,
      "time_unit": null,
      "preferences": {},
      "updated_by_id": 2,
      "created_by_id": 2,
      "created_at": "2021-11-03T11:51:13.759Z",
      "updated_at": "2021-11-03T11:51:13.809Z"
   },
   {
      "id": 2,
      "group_id": 1,
      "priority_id": 2,
      "state_id": 4,
      "organization_id": 3,
      "number": "22002",
      "title": "Order 777555",
      "owner_id": 3,
      "customer_id": 6,
      "note": null,
      "first_response_at": null,
      "first_response_escalation_at": null,
      "first_response_in_min": null,
      "first_response_diff_in_min": null,
      "close_at": null,
      "close_escalation_at": null,
      "close_in_min": null,
      "close_diff_in_min": null,
      "update_escalation_at": null,
      "update_in_min": null,
      "update_diff_in_min": null,
      "last_contact_at": "2021-05-04T16:57:17.920Z",
      "last_contact_agent_at": "2021-05-03T10:57:17.904Z",
      "last_contact_customer_at": "2021-05-04T16:57:17.920Z",
      "last_owner_update_at": null,
      "create_article_type_id": 1,
      "create_article_sender_id": 2,
      "article_count": 3,
      "escalation_at": null,
      "pending_time": null,
      "type": null,
      "time_unit": null,
      "preferences": {},
      "updated_by_id": 6,
      "created_by_id": 6,
      "created_at": "2021-05-03T09:57:17.837Z",
      "updated_at": "2021-11-03T11:57:17.927Z"
   },

   ...
]
```

--------------------------------

### Zammad Rails Console Safe Mode Output Example

Source: https://docs.zammad.org/en/latest/admin/console.html

This example demonstrates the typical output when Zammad's Rails console is started in safe mode, including warnings about unavailable services.

```text
Zammad is running in safe mode. Any third party services like Redis are ignored.

There was an error trying to connect to Redis via redis://localhost:6379.
Please provide a Redis instance at localhost:6379 or set REDIS_URL to point to a different location.
＃<Redis::CannotConnectError: Error connecting to Redis on localhost:6379 (Errno::ECONNREFUSED)>
Loading production environment (Rails 6.1.7.3)
3.1.3 :001 >

```

--------------------------------

### Retrieve Ticket Details

Source: https://docs.zammad.org/en/latest/api/ticket/index.html

Example response for a successful GET request to fetch a specific ticket by ID.

```json
# HTTP-Code 200 Ok

{
   "id": 3,
   "group_id": 1,
   "priority_id": 2,
   "state_id": 4,
   "organization_id": 3,
   "number": "22003",
   "title": "Order 787556",
   "owner_id": 3,
   "customer_id": 7,
   "note": null,
   "first_response_at": null,
   "first_response_escalation_at": null,
   "first_response_in_min": null,
   "first_response_diff_in_min": null,
   "close_at": null,
   "close_escalation_at": null,
   "close_in_min": null,
   "close_diff_in_min": null,
   "update_escalation_at": null,
   "update_in_min": null,
   "update_diff_in_min": null,
   "last_contact_at": "2021-06-03T09:57:17.987Z",
   "last_contact_agent_at": "2021-06-03T09:57:17.987Z",
   "last_contact_customer_at": "2021-06-01T11:57:17.935Z",
   "last_owner_update_at": null,
   "create_article_type_id": 1,
   "create_article_sender_id": 2,
   "article_count": 2,
   "escalation_at": null,
   "pending_time": null,
   "type": null,
   "time_unit": null,
   "preferences": {},
   "updated_by_id": 4,
   "created_by_id": 7,
   "created_at": "2021-06-01T11:57:17.935Z",
   "updated_at": "2021-11-03T11:57:17.997Z"
}
```
Tokens:
Raw