Zammad icon

Zammad

Consume Zammad REST API

Actions57

User → Search

AI-generated

Overview

This node interacts with the Zammad REST API to perform user-related operations, specifically searching for users based on a query. It supports searching users 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 users matching certain criteria, such as in customer support or user management systems.

Use Case Examples

  1. Search users with a specific keyword in their profile or attributes.
  2. Retrieve a limited number of users sorted by their creation date in descending order.

Properties

Name Meaning
Authentication The authentication method to use for the API request, 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 to find users matching the criteria.
Limit The maximum number of users to return in the search results.
Sort By The field by which to sort the user results.
Order By The order direction for sorting the users, either ascending or descending.

Output

JSON

  • id - The unique identifier of the user.
  • login - The login name of the user.
  • firstname - The first name of the user.
  • lastname - The last name of the user.
  • email - The email address of the user.
  • created_at - The timestamp when the user was created.
  • updated_at - The timestamp when the user was last updated.

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 perform search operations.
  • Common error messages may include authentication failures, invalid query parameters, or API endpoint errors. Resolving these typically involves verifying credentials, input parameters, and API availability.

Links

Discussion