Zammad icon

Zammad

Consume Zammad REST API

Actions57

Ticket → Search

AI-generated

Overview

This node interacts with the Zammad REST API to perform various operations on tickets, specifically supporting the 'Search' operation for tickets. It allows users to search for tickets based on a query string, with options to limit the number of results, sort the results by a specified field, and order the results in ascending or descending order. This is useful for scenarios where users need to find specific tickets matching certain criteria, such as searching for tickets containing particular keywords or filtering tickets by status or priority.

Use Case Examples

  1. Searching for tickets containing the keyword 'urgent' to prioritize handling.
  2. Retrieving a limited number of tickets sorted by creation date in descending order to view the most recent tickets first.

Properties

Name Meaning
Authentication The authentication method to use for connecting to the Zammad API, such as Basic Authentication, OAuth2, or Token Authentication.
API The API to use, either the REST API or the CTI API.
Query The search query string used to find tickets matching specific criteria.
Limit The maximum number of tickets to return in the search results.
Sort By The field by which to sort the tickets in the search results.
Order By The order in which to sort the tickets, either ascending or descending.

Output

JSON

  • ``
    • id - The unique identifier of each ticket found.
    • title - The title or subject of each ticket.
    • state - The current state or status of each ticket.
    • priority - The priority level assigned to each ticket.
    • customer_id - The identifier of the customer associated with each ticket.
    • created_at - The creation timestamp of each ticket.
    • updated_at - The last update timestamp of each ticket.

Dependencies

  • Requires authentication credentials for the Zammad API, which can be Basic Auth, OAuth2, or Token Auth.

Troubleshooting

  • Ensure the query parameter is not empty as it is required for searching tickets.
  • Verify that the authentication credentials are correctly configured and valid to avoid authorization errors.
  • Check API limits and pagination if the number of tickets returned is less than expected.
  • If sorting or ordering parameters are invalid or unsupported by the API, the request may fail or return unsorted results.

Links

Discussion