Zammad icon

Zammad

Consume Zammad REST API

Actions57

Organization → Search

AI-generated

Overview

This node interacts with the Zammad REST API to perform operations on organizations. Specifically, the 'Search' operation allows users to search for organizations based on a query string, with options to limit the number of results, sort by a specified field, and order the results in ascending or descending order. This is useful for scenarios where you need to find specific organizations matching certain criteria within Zammad, such as customer or client organizations, and retrieve their details efficiently.

Use Case Examples

  1. Search for organizations containing a specific keyword in their name or description.
  2. Retrieve a limited number of organizations sorted by creation date in descending order.

Properties

Name Meaning
Authentication The authentication method to use for API requests (Basic, OAuth2, or Token Authentication).
API The API to use for the request, either REST API or CTI API.
Query The search query string to find matching organizations.
Limit The maximum number of organizations to return in the search results.
Sort By The field by which to sort the organizations in the search results.
Order By The order direction for sorting the organizations, either ascending or descending.

Output

JSON

  • id - The unique identifier of the organization.
  • name - The name of the organization.
  • created_at - The creation timestamp of the organization.
  • updated_at - The last update timestamp of the organization.
  • other_fields - Additional fields returned by the Zammad API for the organization.

Dependencies

  • Zammad REST API

Troubleshooting

  • Ensure the authentication credentials are correctly configured and valid for the chosen authentication method.
  • Verify that the query parameter is not empty as it is required for the search operation.
  • Check API rate limits and permissions to ensure the user has access to search organizations.
  • If sorting or ordering parameters are invalid or unsupported by the API, the request may fail or return unexpected results.

Links

Discussion