diff --git a/api/includes/sort_and_order.rst b/api/includes/sort_and_order.rst
deleted file mode 100644
index 3f561641..00000000
--- a/api/includes/sort_and_order.rst
+++ /dev/null
@@ -1,3 +0,0 @@
-.. tip:: **↓ Sort and Order ↑**
-
- Have a look into our :ref:`sort_search_results` Section.
diff --git a/api/intro.rst b/api/intro.rst
index e9aa9ed0..74a05b5a 100644
--- a/api/intro.rst
+++ b/api/intro.rst
@@ -20,7 +20,7 @@ endpoints listed here.
*(Official)*
* `Python Client `_ *(Third-Party)*
* `.NET Client `_ *(Third-Party)*
- * `Android API-Client `_
+ * `Android API-Client `_
*(Third-Party)*
* `Go Client `_
*(Third-Party; API client only, no "ready to use" App)*
@@ -50,7 +50,7 @@ HTTP Token Authentication (access token)
| The access token must be provided as HTTP header in the HTTP call.
| Each user can create several access tokens in their user preferences.
| This authentication method can be disabled and may not be available in your
- system.
+ system.
.. code-block:: sh
@@ -556,20 +556,3541 @@ Pagination
As Zammad limits the number of returned objects for performance reasons, you
may have to use pagination at some points.
- .. note::
+.. note::
- **Number of returned objects:** Zammad has hard limits for the maximum
- returned objects. You can't raise these limits.
+ **Number of returned objects:** Zammad has hard limits for the maximum
+ returned objects. You can't raise these limits.
- **Number of total to return objects:** Zammad does not provide a total
- count of objects available for your query. This forces you to cycle
- through the pages until Zammad no longer returns further objects.
+ **Number of total to return objects:** Zammad does not provide a total
+ count of objects available for your query. This forces you to cycle
+ through the pages until Zammad no longer returns further objects.
In order to use pagination you'll need two get options:
``per_page`` and ``page``. Combine them like so to receive 5 results from
the first result page: ``?page=1&per_page=5`` - count page up to get
more results.
+Search via API
+--------------
+
+Endpoint Search
+^^^^^^^^^^^^^^^
+
+Some endpoints support a search query. These are:
+
+- :doc:`Groups `
+- :doc:`Organizations `
+- :doc:`Roles `
+- :doc:`Tickets `
+- :doc:`Users `
+
+The following endpoints support a search query as well, but they are not
+explicitly covered in this documentation:
+
+- Chat Sessions
+- Knowledgebase
+- Macros
+- Overview
+- Templates
+- Text module
+
+
+
+Search example
+ ``GET``-Request sent: ``/api/v1/tickets/search?query=welcome``
+
+ Response:
+
+ .. code-block:: 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": []
+ }
+ ]
+
+``Expand`` Parameter
+ If you want to have additional related information, you can use
+ the ``expand`` parameter. Using it resolves the IDs and outputs values/names
+ in addition.
+
+ ``GET``-Request sent: ``/api/v1/tickets/search?query=welcome&expand=true``
+
+ .. code-block:: 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": [],
+ "referencing_checklists": [],
+ "group": "Users",
+ "organization": "Zammad Foundation",
+ "ticket_time_accounting": [],
+ "state": "new",
+ "priority": "2 normal",
+ "owner": "-",
+ "customer": "nicole.braun@zammad.org",
+ "created_by": "nicole.braun@zammad.org",
+ "updated_by": "nicole.braun@zammad.org",
+ "create_article_type": "phone",
+ "create_article_sender": "Customer"
+ }
+ ]
+
+
+``Full`` Parameter
+ You can even extend the response by using the ``full`` parameter. Be aware
+ that this response can be huge. It outputs all assets including related
+ attributes and a ``total_count`` of search results as well.
+
+ ``GET``-Request sent: ``/api/v1/tickets/search?query=welcome&full=true``
+
+ Response:
+
+ .. code-block:: json
+
+ {
+ "record_ids": [
+ 1
+ ],
+ "assets": {
+ "Ticket": {
+ "1": {
+ "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": []
+ }
+ },
+ "Group": {
+ "1": {
+ "id": 1,
+ "signature_id": 1,
+ "email_address_id": 1,
+ "name": "Users",
+ "name_last": "Users",
+ "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": "Standard Group/Pool for Tickets.",
+ "updated_by_id": 3,
+ "created_by_id": 1,
+ "created_at": "2025-01-14T07:45:08.274Z",
+ "updated_at": "2025-01-14T07:46:20.513Z",
+ "user_ids": [
+ 3
+ ]
+ },
+ "2": {
+ "id": 2,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "Support",
+ "name_last": "Support",
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:20.548Z",
+ "updated_at": "2025-01-14T07:46:20.636Z",
+ "user_ids": [
+ 4,
+ 10,
+ 3
+ ]
+ },
+ "3": {
+ "id": 3,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "Support::1st Level",
+ "name_last": "1st Level",
+ "parent_id": 2,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:20.696Z",
+ "updated_at": "2025-01-14T07:46:20.895Z",
+ "user_ids": [
+ 7,
+ 6,
+ 8,
+ 4,
+ 9,
+ 5,
+ 10,
+ 3
+ ]
+ },
+ "4": {
+ "id": 4,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "Support::2nd Level",
+ "name_last": "2nd Level",
+ "parent_id": 2,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:20.946Z",
+ "updated_at": "2025-01-14T07:46:21.085Z",
+ "user_ids": [
+ 7,
+ 6,
+ 4,
+ 5,
+ 10,
+ 3
+ ]
+ },
+ "5": {
+ "id": 5,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "Sales",
+ "name_last": "Sales",
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:21.149Z",
+ "updated_at": "2025-01-14T07:46:21.249Z",
+ "user_ids": [
+ 14,
+ 13,
+ 10,
+ 3
+ ]
+ },
+ "6": {
+ "id": 6,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "Logistics Department",
+ "name_last": "Logistics Department",
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:21.307Z",
+ "updated_at": "2025-01-14T07:46:21.389Z",
+ "user_ids": [
+ 13,
+ 10,
+ 3
+ ]
+ },
+ "7": {
+ "id": 7,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "Logistics Department::Shipping",
+ "name_last": "Shipping",
+ "parent_id": 6,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:21.447Z",
+ "updated_at": "2025-01-14T07:46:21.531Z",
+ "user_ids": [
+ 13,
+ 10,
+ 3
+ ]
+ },
+ "8": {
+ "id": 8,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "Logistics Department::Returns Processing",
+ "name_last": "Returns Processing",
+ "parent_id": 6,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:21.570Z",
+ "updated_at": "2025-01-14T07:46:21.633Z",
+ "user_ids": [
+ 13,
+ 10,
+ 3
+ ]
+ },
+ "9": {
+ "id": 9,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "IT Internal",
+ "name_last": "IT Internal",
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:21.673Z",
+ "updated_at": "2025-01-14T07:46:21.761Z",
+ "user_ids": [
+ 11,
+ 10,
+ 3
+ ]
+ },
+ "10": {
+ "id": 10,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "IT Internal::Infrastructure",
+ "name_last": "Infrastructure",
+ "parent_id": 9,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:21.813Z",
+ "updated_at": "2025-01-14T07:46:21.881Z",
+ "user_ids": [
+ 11,
+ 10,
+ 3
+ ]
+ },
+ "11": {
+ "id": 11,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "IT Internal::IT Support",
+ "name_last": "IT Support",
+ "parent_id": 9,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:21.932Z",
+ "updated_at": "2025-01-14T07:46:21.995Z",
+ "user_ids": [
+ 12,
+ 10,
+ 3
+ ]
+ }
+ },
+ "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": "2025-01-14T07:45:07.542Z",
+ "updated_at": "2025-01-14T07:45:07.542Z",
+ "role_ids": [],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {}
+ },
+ "3": {
+ "id": 3,
+ "organization_id": 2,
+ "login": "lauren@fastlane.inc",
+ "firstname": "Lauren",
+ "lastname": "Brooks",
+ "email": "lauren@fastlane.inc",
+ "image": "775c807d577dbd6bd95569ec1872f338",
+ "image_source": null,
+ "web": "",
+ "phone": "",
+ "fax": "",
+ "mobile": "",
+ "department": null,
+ "street": "",
+ "zip": "",
+ "city": "",
+ "country": "",
+ "address": null,
+ "vip": false,
+ "verified": false,
+ "active": true,
+ "note": "",
+ "last_login": "2025-01-14T07:46:54.082Z",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": "en-us"
+ },
+ "updated_by_id": 3,
+ "created_by_id": 1,
+ "created_at": "2025-01-14T07:46:17.855Z",
+ "updated_at": "2025-01-14T07:46:58.108Z",
+ "role_ids": [
+ 2,
+ 1
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "1": [
+ "full"
+ ],
+ "2": [
+ "full"
+ ],
+ "3": [
+ "full"
+ ],
+ "4": [
+ "full"
+ ],
+ "5": [
+ "full"
+ ],
+ "6": [
+ "full"
+ ],
+ "7": [
+ "full"
+ ],
+ "8": [
+ "full"
+ ],
+ "9": [
+ "full"
+ ],
+ "10": [
+ "full"
+ ],
+ "11": [
+ "full"
+ ]
+ }
+ },
+ "4": {
+ "id": 4,
+ "organization_id": 2,
+ "login": "ethan@fastlane.inc",
+ "firstname": "Ethan",
+ "lastname": "Kwan",
+ "email": "ethan@fastlane.inc",
+ "image": "3c3a37e93647e40c595937e336953de8",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:18.901Z",
+ "updated_at": "2025-01-14T07:46:26.067Z",
+ "role_ids": [
+ 2
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "2": [
+ "full"
+ ],
+ "3": [
+ "full"
+ ],
+ "4": [
+ "full"
+ ]
+ }
+ },
+ "5": {
+ "id": 5,
+ "organization_id": 2,
+ "login": "julian@fastlane.inc",
+ "firstname": "Julian",
+ "lastname": "Reyes",
+ "email": "julian@fastlane.inc",
+ "image": "5ead44f8048cd52d94198bbb7aa1c0cc",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:19.051Z",
+ "updated_at": "2025-01-14T07:46:26.113Z",
+ "role_ids": [
+ 2
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "3": [
+ "full"
+ ],
+ "4": [
+ "full"
+ ]
+ }
+ },
+ "6": {
+ "id": 6,
+ "organization_id": 2,
+ "login": "thomas@fastlane.inc",
+ "firstname": "Thomas",
+ "lastname": "Lee",
+ "email": "thomas@fastlane.inc",
+ "image": "32340889dbe9bc093f9304d1f708ca6f",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:19.161Z",
+ "updated_at": "2025-01-14T07:46:26.156Z",
+ "role_ids": [
+ 2
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "3": [
+ "full"
+ ],
+ "4": [
+ "full"
+ ]
+ }
+ },
+ "7": {
+ "id": 7,
+ "organization_id": 2,
+ "login": "liam@fastlane.inc",
+ "firstname": "Liam",
+ "lastname": "Chen",
+ "email": "liam@fastlane.inc",
+ "image": "548f5e2072493a829319359384ba3c49",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:19.288Z",
+ "updated_at": "2025-01-14T07:46:26.202Z",
+ "role_ids": [
+ 2
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "3": [
+ "full"
+ ],
+ "4": [
+ "full"
+ ]
+ }
+ },
+ "8": {
+ "id": 8,
+ "organization_id": 2,
+ "login": "alex@fastlane.inc",
+ "firstname": "Alexander",
+ "lastname": "Jensen",
+ "email": "alex@fastlane.inc",
+ "image": "8e837e5b08ef314f920f13e6b8e44b3f",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:19.401Z",
+ "updated_at": "2025-01-14T07:46:26.245Z",
+ "role_ids": [
+ 2
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "3": [
+ "full"
+ ]
+ }
+ },
+ "9": {
+ "id": 9,
+ "organization_id": 2,
+ "login": "emily@fastlane.inc",
+ "firstname": "Emily",
+ "lastname": "Wilson",
+ "email": "emily@fastlane.inc",
+ "image": "f527a90b9dc0c731005f5756bbd5a432",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:19.514Z",
+ "updated_at": "2025-01-14T07:46:26.301Z",
+ "role_ids": [
+ 2
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "3": [
+ "full"
+ ]
+ }
+ },
+ "10": {
+ "id": 10,
+ "organization_id": 2,
+ "login": "hannah@fastlane.inc",
+ "firstname": "Hannah",
+ "lastname": "Taylor",
+ "email": "hannah@fastlane.inc",
+ "image": "7b590e70915e7c33fff328f7e8fa0bb9",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:19.638Z",
+ "updated_at": "2025-01-14T07:46:26.406Z",
+ "role_ids": [
+ 2,
+ 1
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "2": [
+ "full"
+ ],
+ "3": [
+ "full"
+ ],
+ "4": [
+ "full"
+ ],
+ "5": [
+ "full"
+ ],
+ "6": [
+ "full"
+ ],
+ "7": [
+ "full"
+ ],
+ "8": [
+ "full"
+ ],
+ "9": [
+ "full"
+ ],
+ "10": [
+ "full"
+ ],
+ "11": [
+ "full"
+ ]
+ }
+ },
+ "11": {
+ "id": 11,
+ "organization_id": 2,
+ "login": "jackson@fastlane.inc",
+ "firstname": "Jackson",
+ "lastname": "Lee",
+ "email": "jackson@fastlane.inc",
+ "image": "f60bee881cf1856275d4f770ab9f6063",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:19.779Z",
+ "updated_at": "2025-01-14T07:46:26.451Z",
+ "role_ids": [
+ 2,
+ 1
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "9": [
+ "full"
+ ],
+ "10": [
+ "full"
+ ]
+ }
+ },
+ "12": {
+ "id": 12,
+ "organization_id": 2,
+ "login": "emily.t@fastlane.inc",
+ "firstname": "Emily",
+ "lastname": "Tran",
+ "email": "emily.t@fastlane.inc",
+ "image": "c9a8e23fe76079f0d249c87bcd145f95",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:19.893Z",
+ "updated_at": "2025-01-14T07:46:26.493Z",
+ "role_ids": [
+ 2,
+ 1
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "11": [
+ "full"
+ ]
+ }
+ },
+ "2": {
+ "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-01-14T07:45:08.641Z",
+ "updated_at": "2025-01-14T07:45:20.373Z",
+ "role_ids": [
+ 3
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {}
+ }
+ },
+ "Role": {
+ "2": {
+ "id": 2,
+ "name": "Agent",
+ "preferences": {},
+ "default_at_signup": false,
+ "active": true,
+ "note": "To work on Tickets.",
+ "updated_by_id": 3,
+ "created_by_id": 1,
+ "created_at": "2025-01-14T07:45:07.649Z",
+ "updated_at": "2025-01-14T07:46:18.906Z",
+ "permission_ids": [
+ 53,
+ 55,
+ 58,
+ 61,
+ 63
+ ],
+ "knowledge_base_permission_ids": [],
+ "group_ids": {}
+ },
+ "1": {
+ "id": 1,
+ "name": "Admin",
+ "preferences": {},
+ "default_at_signup": false,
+ "active": true,
+ "note": "To configure your system.",
+ "updated_by_id": 3,
+ "created_by_id": 1,
+ "created_at": "2025-01-14T07:45:07.630Z",
+ "updated_at": "2025-01-14T07:46:19.646Z",
+ "permission_ids": [
+ 1,
+ 57,
+ 59,
+ 63
+ ],
+ "knowledge_base_permission_ids": [],
+ "group_ids": {}
+ },
+ "3": {
+ "id": 3,
+ "name": "Customer",
+ "preferences": {},
+ "default_at_signup": true,
+ "active": true,
+ "note": "People who create Tickets ask for help.",
+ "updated_by_id": 3,
+ "created_by_id": 1,
+ "created_at": "2025-01-14T07:45:07.659Z",
+ "updated_at": "2025-01-14T07:46:20.165Z",
+ "permission_ids": [
+ 62,
+ 64,
+ 65,
+ 66,
+ 68,
+ 69,
+ 72
+ ],
+ "knowledge_base_permission_ids": [],
+ "group_ids": {}
+ }
+ },
+ "Organization": {
+ "2": {
+ "id": 2,
+ "name": "Fast Lane Hardware",
+ "shared": true,
+ "domain": "",
+ "domain_assignment": false,
+ "active": true,
+ "vip": false,
+ "note": "IT hardware and custom PC builds",
+ "updated_by_id": 1,
+ "created_by_id": 1,
+ "created_at": "2025-01-14T07:46:17.574Z",
+ "updated_at": "2025-01-14T07:46:17.574Z",
+ "member_ids": [
+ 3,
+ 4,
+ 5,
+ 6,
+ 7,
+ 8,
+ 9,
+ 10,
+ 11,
+ 12,
+ 13,
+ 14
+ ],
+ "secondary_member_ids": []
+ },
+ "1": {
+ "id": 1,
+ "name": "Zammad Foundation",
+ "shared": true,
+ "domain": "",
+ "domain_assignment": false,
+ "active": true,
+ "vip": false,
+ "note": "",
+ "updated_by_id": 1,
+ "created_by_id": 1,
+ "created_at": "2025-01-14T07:45:08.597Z",
+ "updated_at": "2025-01-14T07:45:08.699Z",
+ "member_ids": [
+ 2
+ ],
+ "secondary_member_ids": []
+ }
+ }
+ },
+ "total_count": 1
+ }
+
+
+``Only Total Count`` Parameter
+ Using this parameter will output only the amount of search results.
+
+ ``GET``-Request sent: ``/api/v1/tickets/search?query=welcome&only_total_count=true``
+
+ .. code-block:: json
+
+ {
+ "total_count": 1
+ }
+
+Global Search
+^^^^^^^^^^^^^
+
+If you need to search not only in a specific object type, you can do so by
+using the global search without specifying an object. The response may include
+users, tickets, organizations, knowledgebase articles and answers and chats,
+depending on your system and content. This global search behaves like the
+search in Zammad's UI in the left task bar. The available parameters are
+different to the ones for the endpoint search.
+
+``GET``-Request sent: ``/api/v1/search?query=welcome``
+
+.. code-block:: json
+
+ {
+ "assets": {
+ "Ticket": {
+ "1": {
+ "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": []
+ }
+ },
+ "Group": {
+ "1": {
+ "id": 1,
+ "signature_id": 1,
+ "email_address_id": 1,
+ "name": "Users",
+ "name_last": "Users",
+ "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": "Standard Group/Pool for Tickets.",
+ "updated_by_id": 3,
+ "created_by_id": 1,
+ "created_at": "2025-01-14T07:45:08.274Z",
+ "updated_at": "2025-01-14T07:46:20.513Z",
+ "user_ids": [
+ 3
+ ]
+ },
+ "2": {
+ "id": 2,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "Support",
+ "name_last": "Support",
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:20.548Z",
+ "updated_at": "2025-01-14T07:46:20.636Z",
+ "user_ids": [
+ 4,
+ 10,
+ 3
+ ]
+ },
+ "3": {
+ "id": 3,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "Support::1st Level",
+ "name_last": "1st Level",
+ "parent_id": 2,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:20.696Z",
+ "updated_at": "2025-01-14T07:46:20.895Z",
+ "user_ids": [
+ 7,
+ 6,
+ 8,
+ 4,
+ 9,
+ 5,
+ 10,
+ 3
+ ]
+ },
+ "4": {
+ "id": 4,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "Support::2nd Level",
+ "name_last": "2nd Level",
+ "parent_id": 2,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:20.946Z",
+ "updated_at": "2025-01-14T07:46:21.085Z",
+ "user_ids": [
+ 7,
+ 6,
+ 4,
+ 5,
+ 10,
+ 3
+ ]
+ },
+ "5": {
+ "id": 5,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "Sales",
+ "name_last": "Sales",
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:21.149Z",
+ "updated_at": "2025-01-14T07:46:21.249Z",
+ "user_ids": [
+ 14,
+ 13,
+ 10,
+ 3
+ ]
+ },
+ "6": {
+ "id": 6,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "Logistics Department",
+ "name_last": "Logistics Department",
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:21.307Z",
+ "updated_at": "2025-01-14T07:46:21.389Z",
+ "user_ids": [
+ 13,
+ 10,
+ 3
+ ]
+ },
+ "7": {
+ "id": 7,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "Logistics Department::Shipping",
+ "name_last": "Shipping",
+ "parent_id": 6,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:21.447Z",
+ "updated_at": "2025-01-14T07:46:21.531Z",
+ "user_ids": [
+ 13,
+ 10,
+ 3
+ ]
+ },
+ "8": {
+ "id": 8,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "Logistics Department::Returns Processing",
+ "name_last": "Returns Processing",
+ "parent_id": 6,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:21.570Z",
+ "updated_at": "2025-01-14T07:46:21.633Z",
+ "user_ids": [
+ 13,
+ 10,
+ 3
+ ]
+ },
+ "9": {
+ "id": 9,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "IT Internal",
+ "name_last": "IT Internal",
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:21.673Z",
+ "updated_at": "2025-01-14T07:46:21.761Z",
+ "user_ids": [
+ 11,
+ 10,
+ 3
+ ]
+ },
+ "10": {
+ "id": 10,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "IT Internal::Infrastructure",
+ "name_last": "Infrastructure",
+ "parent_id": 9,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:21.813Z",
+ "updated_at": "2025-01-14T07:46:21.881Z",
+ "user_ids": [
+ 11,
+ 10,
+ 3
+ ]
+ },
+ "11": {
+ "id": 11,
+ "signature_id": null,
+ "email_address_id": null,
+ "name": "IT Internal::IT Support",
+ "name_last": "IT Support",
+ "parent_id": 9,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:21.932Z",
+ "updated_at": "2025-01-14T07:46:21.995Z",
+ "user_ids": [
+ 12,
+ 10,
+ 3
+ ]
+ }
+ },
+ "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": "2025-01-14T07:45:07.542Z",
+ "updated_at": "2025-01-14T07:45:07.542Z",
+ "role_ids": [],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {}
+ },
+ "3": {
+ "id": 3,
+ "organization_id": 2,
+ "login": "lauren@fastlane.inc",
+ "firstname": "Lauren",
+ "lastname": "Brooks",
+ "email": "lauren@fastlane.inc",
+ "image": "775c807d577dbd6bd95569ec1872f338",
+ "image_source": null,
+ "web": "",
+ "phone": "",
+ "fax": "",
+ "mobile": "",
+ "department": null,
+ "street": "",
+ "zip": "",
+ "city": "",
+ "country": "",
+ "address": null,
+ "vip": false,
+ "verified": false,
+ "active": true,
+ "note": "",
+ "last_login": "2025-01-14T07:46:54.082Z",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": "en-us"
+ },
+ "updated_by_id": 3,
+ "created_by_id": 1,
+ "created_at": "2025-01-14T07:46:17.855Z",
+ "updated_at": "2025-01-14T07:46:58.108Z",
+ "role_ids": [
+ 2,
+ 1
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "1": [
+ "full"
+ ],
+ "2": [
+ "full"
+ ],
+ "3": [
+ "full"
+ ],
+ "4": [
+ "full"
+ ],
+ "5": [
+ "full"
+ ],
+ "6": [
+ "full"
+ ],
+ "7": [
+ "full"
+ ],
+ "8": [
+ "full"
+ ],
+ "9": [
+ "full"
+ ],
+ "10": [
+ "full"
+ ],
+ "11": [
+ "full"
+ ]
+ }
+ },
+ "4": {
+ "id": 4,
+ "organization_id": 2,
+ "login": "ethan@fastlane.inc",
+ "firstname": "Ethan",
+ "lastname": "Kwan",
+ "email": "ethan@fastlane.inc",
+ "image": "3c3a37e93647e40c595937e336953de8",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:18.901Z",
+ "updated_at": "2025-01-14T07:46:26.067Z",
+ "role_ids": [
+ 2
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "2": [
+ "full"
+ ],
+ "3": [
+ "full"
+ ],
+ "4": [
+ "full"
+ ]
+ }
+ },
+ "5": {
+ "id": 5,
+ "organization_id": 2,
+ "login": "julian@fastlane.inc",
+ "firstname": "Julian",
+ "lastname": "Reyes",
+ "email": "julian@fastlane.inc",
+ "image": "5ead44f8048cd52d94198bbb7aa1c0cc",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:19.051Z",
+ "updated_at": "2025-01-14T07:46:26.113Z",
+ "role_ids": [
+ 2
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "3": [
+ "full"
+ ],
+ "4": [
+ "full"
+ ]
+ }
+ },
+ "6": {
+ "id": 6,
+ "organization_id": 2,
+ "login": "thomas@fastlane.inc",
+ "firstname": "Thomas",
+ "lastname": "Lee",
+ "email": "thomas@fastlane.inc",
+ "image": "32340889dbe9bc093f9304d1f708ca6f",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:19.161Z",
+ "updated_at": "2025-01-14T07:46:26.156Z",
+ "role_ids": [
+ 2
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "3": [
+ "full"
+ ],
+ "4": [
+ "full"
+ ]
+ }
+ },
+ "7": {
+ "id": 7,
+ "organization_id": 2,
+ "login": "liam@fastlane.inc",
+ "firstname": "Liam",
+ "lastname": "Chen",
+ "email": "liam@fastlane.inc",
+ "image": "548f5e2072493a829319359384ba3c49",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:19.288Z",
+ "updated_at": "2025-01-14T07:46:26.202Z",
+ "role_ids": [
+ 2
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "3": [
+ "full"
+ ],
+ "4": [
+ "full"
+ ]
+ }
+ },
+ "8": {
+ "id": 8,
+ "organization_id": 2,
+ "login": "alex@fastlane.inc",
+ "firstname": "Alexander",
+ "lastname": "Jensen",
+ "email": "alex@fastlane.inc",
+ "image": "8e837e5b08ef314f920f13e6b8e44b3f",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:19.401Z",
+ "updated_at": "2025-01-14T07:46:26.245Z",
+ "role_ids": [
+ 2
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "3": [
+ "full"
+ ]
+ }
+ },
+ "9": {
+ "id": 9,
+ "organization_id": 2,
+ "login": "emily@fastlane.inc",
+ "firstname": "Emily",
+ "lastname": "Wilson",
+ "email": "emily@fastlane.inc",
+ "image": "f527a90b9dc0c731005f5756bbd5a432",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:19.514Z",
+ "updated_at": "2025-01-14T07:46:26.301Z",
+ "role_ids": [
+ 2
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "3": [
+ "full"
+ ]
+ }
+ },
+ "10": {
+ "id": 10,
+ "organization_id": 2,
+ "login": "hannah@fastlane.inc",
+ "firstname": "Hannah",
+ "lastname": "Taylor",
+ "email": "hannah@fastlane.inc",
+ "image": "7b590e70915e7c33fff328f7e8fa0bb9",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:19.638Z",
+ "updated_at": "2025-01-14T07:46:26.406Z",
+ "role_ids": [
+ 2,
+ 1
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "2": [
+ "full"
+ ],
+ "3": [
+ "full"
+ ],
+ "4": [
+ "full"
+ ],
+ "5": [
+ "full"
+ ],
+ "6": [
+ "full"
+ ],
+ "7": [
+ "full"
+ ],
+ "8": [
+ "full"
+ ],
+ "9": [
+ "full"
+ ],
+ "10": [
+ "full"
+ ],
+ "11": [
+ "full"
+ ]
+ }
+ },
+ "11": {
+ "id": 11,
+ "organization_id": 2,
+ "login": "jackson@fastlane.inc",
+ "firstname": "Jackson",
+ "lastname": "Lee",
+ "email": "jackson@fastlane.inc",
+ "image": "f60bee881cf1856275d4f770ab9f6063",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:19.779Z",
+ "updated_at": "2025-01-14T07:46:26.451Z",
+ "role_ids": [
+ 2,
+ 1
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "9": [
+ "full"
+ ],
+ "10": [
+ "full"
+ ]
+ }
+ },
+ "12": {
+ "id": 12,
+ "organization_id": 2,
+ "login": "emily.t@fastlane.inc",
+ "firstname": "Emily",
+ "lastname": "Tran",
+ "email": "emily.t@fastlane.inc",
+ "image": "c9a8e23fe76079f0d249c87bcd145f95",
+ "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": {
+ "intro": true,
+ "keyboard_shortcuts_clues": true,
+ "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": 3,
+ "created_by_id": 3,
+ "created_at": "2025-01-14T07:46:19.893Z",
+ "updated_at": "2025-01-14T07:46:26.493Z",
+ "role_ids": [
+ 2,
+ 1
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {
+ "11": [
+ "full"
+ ]
+ }
+ },
+ "2": {
+ "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-01-14T07:45:08.641Z",
+ "updated_at": "2025-01-14T07:45:20.373Z",
+ "role_ids": [
+ 3
+ ],
+ "two_factor_preference_ids": [],
+ "organization_ids": [],
+ "authorization_ids": [],
+ "overview_sorting_ids": [],
+ "group_ids": {}
+ }
+ },
+ "Role": {
+ "2": {
+ "id": 2,
+ "name": "Agent",
+ "preferences": {},
+ "default_at_signup": false,
+ "active": true,
+ "note": "To work on Tickets.",
+ "updated_by_id": 3,
+ "created_by_id": 1,
+ "created_at": "2025-01-14T07:45:07.649Z",
+ "updated_at": "2025-01-14T07:46:18.906Z",
+ "permission_ids": [
+ 53,
+ 55,
+ 58,
+ 61,
+ 63
+ ],
+ "knowledge_base_permission_ids": [],
+ "group_ids": {}
+ },
+ "1": {
+ "id": 1,
+ "name": "Admin",
+ "preferences": {},
+ "default_at_signup": false,
+ "active": true,
+ "note": "To configure your system.",
+ "updated_by_id": 3,
+ "created_by_id": 1,
+ "created_at": "2025-01-14T07:45:07.630Z",
+ "updated_at": "2025-01-14T07:46:19.646Z",
+ "permission_ids": [
+ 1,
+ 57,
+ 59,
+ 63
+ ],
+ "knowledge_base_permission_ids": [],
+ "group_ids": {}
+ },
+ "3": {
+ "id": 3,
+ "name": "Customer",
+ "preferences": {},
+ "default_at_signup": true,
+ "active": true,
+ "note": "People who create Tickets ask for help.",
+ "updated_by_id": 3,
+ "created_by_id": 1,
+ "created_at": "2025-01-14T07:45:07.659Z",
+ "updated_at": "2025-01-14T07:46:20.165Z",
+ "permission_ids": [
+ 62,
+ 64,
+ 65,
+ 66,
+ 68,
+ 69,
+ 72
+ ],
+ "knowledge_base_permission_ids": [],
+ "group_ids": {}
+ }
+ },
+ "Organization": {
+ "2": {
+ "id": 2,
+ "name": "Fast Lane Hardware",
+ "shared": true,
+ "domain": "",
+ "domain_assignment": false,
+ "active": true,
+ "vip": false,
+ "note": "IT hardware and custom PC builds",
+ "updated_by_id": 1,
+ "created_by_id": 1,
+ "created_at": "2025-01-14T07:46:17.574Z",
+ "updated_at": "2025-01-14T07:46:17.574Z",
+ "member_ids": [
+ 3,
+ 4,
+ 5,
+ 6,
+ 7,
+ 8,
+ 9,
+ 10,
+ 11,
+ 12,
+ 13,
+ 14
+ ],
+ "secondary_member_ids": []
+ },
+ "1": {
+ "id": 1,
+ "name": "Zammad Foundation",
+ "shared": true,
+ "domain": "",
+ "domain_assignment": false,
+ "active": true,
+ "vip": false,
+ "note": "",
+ "updated_by_id": 1,
+ "created_by_id": 1,
+ "created_at": "2025-01-14T07:45:08.597Z",
+ "updated_at": "2025-01-14T07:45:08.699Z",
+ "member_ids": [
+ 2
+ ],
+ "secondary_member_ids": []
+ }
+ }
+ },
+ "result": [
+ {
+ "type": "Ticket",
+ "id": 1
+ }
+ ]
+ }
+
+
+Condition Based Search
+^^^^^^^^^^^^^^^^^^^^^^
+
+You can even use conditions like for triggers and schedulers to search via
+API. If you don't want to build such conditions manually, you can find a hint
+below how to quickly build a condition structure via UI and fetch it for you API
+request.
+
+So, how do I build such a condition based request?
+
+- In Zammad, go to the admin interface and create a condition, e.g. by creating
+ a new overview or trigger. It can be inactive so you won't have any unwanted
+ actions or changes.
+- Go to the :doc:`Rails console `, either by using ``rails c`` /
+ ``zammad run rails c`` or adding the prefix ``rails r`` /
+ ``zammad run rails r`` in front of the commands below, depending on your
+ setup.
+- Search for the created condition, adjust the following examples to your needs:
+
+.. code-block:: ruby
+
+ puts Overview.find_by(name: 'My test overview').attributes.slice('condition').to_json
+
+.. code-block:: ruby
+
+ puts Trigger.find_by(name: 'My new test trigger').attributes.slice('condition').to_json
+
+This leads to an output like the following:
+
+.. code-block:: json
+
+ {"condition":{"ticket.state_id":{"operator":"is","value":["2"]},"ticket.title":{"operator":"contains","value":"Test"}}}
+
+Use this as payload in your ``POST``-Request in an endpoint search. The response
+includes the same objects as the trigger or overview you created.
+
.. _sort_search_results:
Sorting Search Results
diff --git a/api/organization.rst b/api/organization.rst
index b6299e98..3a6f72c1 100644
--- a/api/organization.rst
+++ b/api/organization.rst
@@ -98,83 +98,6 @@ Response:
}
]
-Search
-------
-
-Required permission: ``ticket.agent`` **or** ``admin.organization``
-
-``GET``-Request sent:
-``/api/v1/organizations/search?query=inc&limit=10``
-
-.. include:: /api/includes/sort_and_order.rst
-
-Response:
-
-.. code-block:: json
- :force:
-
- # HTTP-Code 200 Ok
-
- [
- {
- "name": "Awesome Customer Inc.",
- "shared": true,
- "domain": "",
- "domain_assignment": false,
- "active": true,
- "note": "Global distributor of communication and security products, electrical and electronic wire & cable.",
- "vip": true,
- "updated_by_id": 3,
- "id": 3,
- "created_by_id": 1,
- "created_at": "2023-07-26T08:44:48.632Z",
- "updated_at": "2023-08-04T12:54:30.974Z",
- "member_ids": [
- 8,
- 7,
- 6
- ],
- "secondary_member_ids": []
- },
- {
- "name": "Chrispresso Inc.",
- "shared": true,
- "domain": "",
- "domain_assignment": false,
- "active": true,
- "note": "Manufacturer of individual coffee products.",
- "vip": false,
- "updated_by_id": 3,
- "id": 2,
- "created_by_id": 1,
- "created_at": "2023-07-26T08:44:48.617Z",
- "updated_at": "2023-08-04T12:01:44.370Z",
- "member_ids": [
- 3,
- 5,
- 4
- ],
- "secondary_member_ids": []
- },
- {
- "id": 4,
- "name": "Good Customer Inc.",
- "shared": true,
- "domain": "",
- "domain_assignment": false,
- "active": true,
- "note": "Search the world's information, including webpages, images, videos and more. Good Customer has many special features to help you find exactly what you're looking for.",
- "updated_by_id": 1,
- "created_by_id": 1,
- "created_at": "2023-07-26T08:44:48.645Z",
- "updated_at": "2023-07-26T08:44:48.645Z",
- "member_ids": [
- 9
- ],
- "secondary_member_ids": []
- }
- ]
-
Show
----
diff --git a/api/ticket/index.rst b/api/ticket/index.rst
index 9cf9dfd5..b797d5b6 100644
--- a/api/ticket/index.rst
+++ b/api/ticket/index.rst
@@ -103,1055 +103,6 @@ Response:
...
]
-Search
-------
-
-Required permission: ``ticket.agent`` **or** ``ticket.customer``
-
-``GET``-Request sent: ``/api/v1/tickets/search?query={search string}&limit=10``
-
-.. include:: /api/includes/sort_and_order.rst
-
-Response:
-
-.. code-block:: json
- :force:
-
- # HTTP-Code 200 Ok
-
- {
- "tickets": [
- 9,
- 10,
- 11
- ],
- "tickets_count": 3,
- "assets": {
- "Ticket": {
- "9": {
- "id": 9,
- "group_id": 1,
- "priority_id": 3,
- "state_id": 2,
- "organization_id": 7,
- "number": "22009",
- "title": "Need more information!",
- "owner_id": 5,
- "customer_id": 10,
- "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-03T05:42:19.141Z",
- "last_contact_agent_at": "2021-11-03T05:42:19.141Z",
- "last_contact_customer_at": "2021-11-03T02:57:19.141Z",
- "last_owner_update_at": null,
- "create_article_type_id": 1,
- "create_article_sender_id": 2,
- "article_count": 4,
- "escalation_at": null,
- "pending_time": null,
- "type": null,
- "time_unit": null,
- "preferences": {},
- "updated_by_id": 3,
- "created_by_id": 10,
- "created_at": "2021-11-03T02:57:19.141Z",
- "updated_at": "2021-11-03T17:48:52.849Z",
- "article_ids": [
- 19,
- 18,
- 17,
- 16
- ],
- "ticket_time_accounting_ids": []
- },
- "10": {
- "id": 10,
- "group_id": 1,
- "priority_id": 3,
- "state_id": 1,
- "organization_id": 7,
- "number": "22010",
- "title": "Heads up 🕹!",
- "owner_id": 1,
- "customer_id": 11,
- "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:57:19.227Z",
- "last_contact_agent_at": null,
- "last_contact_customer_at": "2021-11-03T11:57:19.227Z",
- "last_owner_update_at": null,
- "create_article_type_id": 1,
- "create_article_sender_id": 2,
- "article_count": 1,
- "escalation_at": null,
- "pending_time": null,
- "type": null,
- "time_unit": null,
- "preferences": {},
- "updated_by_id": 3,
- "created_by_id": 11,
- "created_at": "2021-11-03T02:57:19.216Z",
- "updated_at": "2021-11-03T17:48:52.730Z",
- "article_ids": [
- 20
- ],
- "ticket_time_accounting_ids": []
- },
- "11": {
- "id": 11,
- "group_id": 1,
- "priority_id": 3,
- "state_id": 1,
- "organization_id": 3,
- "number": "22011",
- "title": "Surprise - well done",
- "owner_id": 1,
- "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-11-03T02:57:19.243Z",
- "last_contact_agent_at": null,
- "last_contact_customer_at": "2021-11-03T02:57:19.243Z",
- "last_owner_update_at": null,
- "create_article_type_id": 11,
- "create_article_sender_id": 2,
- "article_count": 1,
- "escalation_at": null,
- "pending_time": null,
- "type": null,
- "time_unit": null,
- "preferences": {},
- "updated_by_id": 6,
- "created_by_id": 6,
- "created_at": "2021-11-03T02:57:19.243Z",
- "updated_at": "2021-11-03T11:57:19.263Z",
- "article_ids": [
- 21
- ],
- "ticket_time_accounting_ids": []
- }
- },
- "User": {
- "10": {
- "id": 10,
- "organization_id": null,
- "login": "david@example.com",
- "firstname": "David",
- "lastname": "Bell",
- "email": "david@example.com",
- "image": "d829d234f377f231534802df6d5500a7",
- "image_source": null,
- "web": "",
- "phone": "0033 892 12 34 56",
- "fax": "",
- "mobile": "",
- "department": "",
- "street": "",
- "zip": "",
- "city": "",
- "country": "",
- "address": "Eiffel Tower\r\n5 Avenue Anatole France\r\n75007 Paris",
- "vip": false,
- "verified": false,
- "active": true,
- "note": "did order viennese melange, 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": {
- "tickets_closed": 1,
- "tickets_open": 3,
- "mail_delivery_failed": true,
- "mail_delivery_failed_data": "2021-11-08T13:38:32.059Z"
- },
- "updated_by_id": 1,
- "created_by_id": 1,
- "created_at": "2021-11-03T11:57:17.495Z",
- "updated_at": "2021-11-08T13:45:04.107Z",
- "role_ids": [
- 3
- ],
- "organization_ids": [],
- "authorization_ids": [],
- "karma_user_ids": [],
- "group_ids": {},
- "accounts": {}
- },
- "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": "2021-11-03T11:51:12.786Z",
- "updated_at": "2021-11-03T11:51:12.786Z",
- "role_ids": [],
- "organization_ids": [],
- "authorization_ids": [],
- "karma_user_ids": [],
- "group_ids": {},
- "accounts": {}
- },
- "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": "",
- "street": "",
- "zip": "",
- "city": "",
- "country": "",
- "address": "",
- "vip": false,
- "verified": false,
- "active": true,
- "note": "",
- "last_login": "2021-11-03T12:26:53.410Z",
- "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": "en-us",
- "intro": true,
- "chat": {
- "active": {
- "1": "on"
- }
- }
- },
- "updated_by_id": 3,
- "created_by_id": 1,
- "created_at": "2021-11-03T11:57:15.975Z",
- "updated_at": "2021-11-08T13:45:07.798Z",
- "role_ids": [
- 1,
- 2
- ],
- "organization_ids": [],
- "authorization_ids": [],
- "karma_user_ids": [
- 1
- ],
- "group_ids": {
- "1": [
- "full"
- ],
- "2": [
- "full"
- ],
- "3": [
- "full"
- ]
- },
- "accounts": {}
- },
- "4": {
- "id": 4,
- "organization_id": 2,
- "login": "jacob@chrispresso.com",
- "firstname": "Jacob",
- "lastname": "Smith",
- "email": "jacob@chrispresso.com",
- "image": "95afc1244af5cb8b77edcd7224c5d5f8",
- "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": "en-us"
- },
- "updated_by_id": 1,
- "created_by_id": 1,
- "created_at": "2021-11-03T11:57:16.160Z",
- "updated_at": "2021-11-03T11:57:16.214Z",
- "role_ids": [
- 1,
- 2
- ],
- "organization_ids": [],
- "authorization_ids": [],
- "karma_user_ids": [],
- "group_ids": {
- "1": [
- "full"
- ],
- "2": [
- "full"
- ],
- "3": [
- "full"
- ]
- },
- "accounts": {}
- },
- "5": {
- "id": 5,
- "organization_id": 7,
- "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": {
- "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": "en-us"
- },
- "updated_by_id": 3,
- "created_by_id": 1,
- "created_at": "2021-11-03T11:57:16.349Z",
- "updated_at": "2021-11-08T13:22:38.130Z",
- "role_ids": [
- 2
- ],
- "organization_ids": [],
- "authorization_ids": [],
- "karma_user_ids": [],
- "group_ids": {
- "1": [
- "full"
- ],
- "2": [
- "full"
- ],
- "3": [
- "full"
- ]
- },
- "accounts": {}
- },
- "11": {
- "id": 11,
- "organization_id": 7,
- "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": "",
- "street": "",
- "zip": "",
- "city": "",
- "country": "",
- "address": "Westminster\r\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": {
- "tickets_closed": 0,
- "tickets_open": 1
- },
- "updated_by_id": 3,
- "created_by_id": 1,
- "created_at": "2021-11-03T11:57:17.741Z",
- "updated_at": "2021-11-03T17:48:52.739Z",
- "role_ids": [
- 3
- ],
- "organization_ids": [],
- "authorization_ids": [],
- "karma_user_ids": [],
- "group_ids": {},
- "accounts": {}
- },
- "16": {
- "id": 16,
- "organization_id": 7,
- "login": "jdoe",
- "firstname": "Jane",
- "lastname": "Doe",
- "email": "jdoe@example.com",
- "image": null,
- "image_source": null,
- "web": "",
- "phone": "+49 30 55 57 160 00",
- "fax": "",
- "mobile": "",
- "department": "Sales",
- "street": "",
- "zip": "",
- "city": "",
- "country": "",
- "address": "Marienstr. 18\r\n10117 Berlin",
- "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": "en-us"
- },
- "updated_by_id": 3,
- "created_by_id": 3,
- "created_at": "2021-11-03T14:42:36.855Z",
- "updated_at": "2021-11-08T13:20:18.500Z",
- "role_ids": [
- 2,
- 3
- ],
- "organization_ids": [],
- "authorization_ids": [],
- "karma_user_ids": [],
- "group_ids": {},
- "accounts": {}
- },
- "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": {},
- "updated_by_id": 1,
- "created_by_id": 1,
- "created_at": "2021-11-03T11:57:16.526Z",
- "updated_at": "2021-11-03T11:57:16.611Z",
- "role_ids": [
- 3
- ],
- "organization_ids": [],
- "authorization_ids": [],
- "karma_user_ids": [],
- "group_ids": {},
- "accounts": {}
- },
- "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": {},
- "updated_by_id": 1,
- "created_by_id": 1,
- "created_at": "2021-11-03T11:57:16.748Z",
- "updated_at": "2021-11-03T11:57:16.861Z",
- "role_ids": [
- 3
- ],
- "organization_ids": [],
- "authorization_ids": [],
- "karma_user_ids": [],
- "group_ids": {},
- "accounts": {}
- },
- "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": {},
- "updated_by_id": 1,
- "created_by_id": 1,
- "created_at": "2021-11-03T11:57:17.000Z",
- "updated_at": "2021-11-03T11:57:17.060Z",
- "role_ids": [
- 3
- ],
- "organization_ids": [],
- "authorization_ids": [],
- "karma_user_ids": [],
- "group_ids": {},
- "accounts": {}
- }
- },
- "Role": {
- "3": {
- "id": 3,
- "name": "Customer",
- "preferences": {},
- "default_at_signup": true,
- "active": true,
- "note": "People who create Tickets ask for help.",
- "updated_by_id": 1,
- "created_by_id": 1,
- "created_at": "2021-11-03T11:51:12.856Z",
- "updated_at": "2021-11-08T13:38:31.573Z",
- "permission_ids": [
- 42,
- 45,
- 46,
- 48,
- 54
- ],
- "group_ids": {}
- },
- "1": {
- "id": 1,
- "name": "Admin",
- "preferences": {},
- "default_at_signup": false,
- "active": true,
- "note": "To configure your system.",
- "updated_by_id": 1,
- "created_by_id": 1,
- "created_at": "2021-11-03T11:51:12.831Z",
- "updated_at": "2021-11-03T11:51:12.831Z",
- "permission_ids": [
- 1,
- 41,
- 51,
- 61
- ],
- "group_ids": {}
- },
- "2": {
- "id": 2,
- "name": "Agent",
- "preferences": {},
- "default_at_signup": false,
- "active": true,
- "note": "To work on Tickets.",
- "updated_by_id": 3,
- "created_by_id": 1,
- "created_at": "2021-11-03T11:51:12.848Z",
- "updated_at": "2021-11-03T14:42:36.875Z",
- "permission_ids": [
- 41,
- 53,
- 56,
- 58,
- 62
- ],
- "group_ids": {}
- }
- },
- "Group": {
- "1": {
- "id": 1,
- "signature_id": 1,
- "email_address_id": null,
- "name": "Sales",
- "assignment_timeout": null,
- "follow_up_possible": "yes",
- "follow_up_assignment": true,
- "active": true,
- "note": "Standard Group/Pool for Tickets.",
- "updated_by_id": 1,
- "created_by_id": 1,
- "created_at": "2021-11-03T11:51:13.449Z",
- "updated_at": "2021-11-08T13:37:57.093Z",
- "user_ids": [
- 4,
- 5,
- 3
- ]
- },
- "2": {
- "id": 2,
- "signature_id": null,
- "email_address_id": null,
- "name": "2nd Level",
- "assignment_timeout": null,
- "follow_up_possible": "yes",
- "follow_up_assignment": true,
- "active": true,
- "note": null,
- "updated_by_id": 1,
- "created_by_id": 1,
- "created_at": "2021-11-03T11:57:15.802Z",
- "updated_at": "2021-11-08T13:37:57.097Z",
- "user_ids": [
- 4,
- 5,
- 3
- ]
- },
- "3": {
- "id": 3,
- "signature_id": null,
- "email_address_id": null,
- "name": "Service Desk",
- "assignment_timeout": null,
- "follow_up_possible": "yes",
- "follow_up_assignment": true,
- "active": true,
- "note": null,
- "updated_by_id": 1,
- "created_by_id": 1,
- "created_at": "2021-11-03T11:57:15.807Z",
- "updated_at": "2021-11-08T13:37:57.102Z",
- "user_ids": [
- 4,
- 5,
- 3
- ]
- }
- },
- "Organization": {
- "2": {
- "id": 2,
- "name": "Chrispresso Inc.",
- "shared": true,
- "domain": "",
- "domain_assignment": false,
- "active": true,
- "note": "Manufacturer of individual coffee products.",
- "updated_by_id": 1,
- "created_by_id": 1,
- "created_at": "2021-11-03T11:57:15.817Z",
- "updated_at": "2021-11-08T13:22:38.145Z",
- "member_ids": [
- 3,
- 4
- ]
- },
- "7": {
- "id": 7,
- "name": "Sample Corp.",
- "shared": false,
- "domain": "",
- "domain_assignment": false,
- "active": true,
- "note": "This was a triump - I'm making a note here - H-U-G-E success!",
- "updated_by_id": 3,
- "created_by_id": 3,
- "created_at": "2021-11-03T17:48:52.613Z",
- "updated_at": "2021-11-08T13:22:38.148Z",
- "member_ids": [
- 5,
- 11,
- 16
- ]
- },
- "3": {
- "id": 3,
- "name": "Awesome Customer Inc.",
- "shared": true,
- "domain": "",
- "domain_assignment": false,
- "active": true,
- "note": "Global distributor of communication and security products, electrical and electronic wire & cable.",
- "updated_by_id": 1,
- "created_by_id": 1,
- "created_at": "2021-11-03T11:57:15.825Z",
- "updated_at": "2021-11-03T11:57:15.825Z",
- "member_ids": [
- 6,
- 7,
- 8
- ]
- }
- }
- }
- }
-
-.. warning::
-
- ``tickets_count`` returns the *current* number of returned tickets, not
- *the total amount*.
-
Show
----
diff --git a/api/ticket/tags.rst b/api/ticket/tags.rst
index dbcb47eb..b5735c4e 100644
--- a/api/ticket/tags.rst
+++ b/api/ticket/tags.rst
@@ -25,38 +25,6 @@ Sample response:
]
}
-
-Search
-^^^^^^
-
-Required permission: ``ticket.agent`` **or** ``admin.tag``
-
-``GET``-Request sent: ``/api/v1/tag_search?term={tag name}``
-
-.. hint:: Zammad will return all tags that contain your search phrase.
-
-Sample response:
-
-.. code-block:: json
- :force:
-
- # HTTP-Code 200 OK
-
- [
- {
- "id": 1,
- "value": "americano"
- },
- {
- "id": 2,
- "value": "complaint"
- },
- {
- "id": 3,
- "value": "viennese melange"
- }
- ]
-
Add
^^^
diff --git a/api/user.rst b/api/user.rst
index ec82fd54..fb1a1d5d 100644
--- a/api/user.rst
+++ b/api/user.rst
@@ -963,157 +963,6 @@ Response:
}
]
-
-
-Search
-------
-
-Required permission: ``ticket.agent`` **or** ``admin.user``
-
-``GET``-Request sent:
-``/api/v1/users/search?query=organization.name:{search string}&limit=10``
-
-.. include:: /api/includes/sort_and_order.rst
-
-Response:
-
-.. code-block:: json
- :force:
-
- # HTTP-Code 200 Ok
-
- [
- {
- "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": {},
- "updated_by_id": 1,
- "created_by_id": 1,
- "created_at": "2021-11-03T11:57:17.000Z",
- "updated_at": "2021-11-03T11:57:17.060Z",
- "role_ids": [
- 3
- ],
- "organization_ids": [],
- "authorization_ids": [],
- "karma_user_ids": [],
- "group_ids": {}
- },
- {
- "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": {},
- "updated_by_id": 1,
- "created_by_id": 1,
- "created_at": "2021-11-03T11:57:16.748Z",
- "updated_at": "2021-11-03T11:57:16.861Z",
- "role_ids": [
- 3
- ],
- "organization_ids": [],
- "authorization_ids": [],
- "karma_user_ids": [],
- "group_ids": {}
- },
- {
- "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": {},
- "updated_by_id": 1,
- "created_by_id": 1,
- "created_at": "2021-11-03T11:57:16.526Z",
- "updated_at": "2021-11-03T11:57:16.611Z",
- "role_ids": [
- 3
- ],
- "organization_ids": [],
- "authorization_ids": [],
- "karma_user_ids": [],
- "group_ids": {}
- }
- ]
-
Show
----
diff --git a/appendix/backup-and-restore/console-command-note.include.rst b/appendix/backup-and-restore/console-command-note.include.rst
index 5ccc1dbf..10c2ecf0 100644
--- a/appendix/backup-and-restore/console-command-note.include.rst
+++ b/appendix/backup-and-restore/console-command-note.include.rst
@@ -1,3 +1,5 @@
+:orphan:
+
.. note::
Keep in mind that docker-compose and source code installations do not know