AvantGuard - NinjaOne

Actions159

Overview

This node operation "Get All User And Contacts" under the "Ticketing" resource is designed to retrieve a list of users and contacts from an external system, likely a ticketing or IT service management platform. It supports filtering and pagination through various query parameters, enabling efficient retrieval of user data such as technicians, end users, and contacts.

Common scenarios where this node would be beneficial include:

Synchronizing user and contact lists from the ticketing system into another application.
Generating reports or dashboards based on user roles or types.
Automating workflows that require up-to-date user information for ticket assignments or notifications.

For example, you could use this node to fetch all technicians currently registered in the system with a page size limit, or search for users by their email address to verify their existence before creating tickets.

Properties

Name	Meaning
Additional Query Parameters	Optional filters and pagination controls:
- Page Size	Limit number of records per page (number)
- Anchor Natural Id	Last User Identifier from previous page (number), used for pagination
- Search Criteria	Search string to filter users by first name, last name, or email address (string)
- User Type	Type of user to retrieve; options are TECHNICIAN, END USER, CONTACT
- Client Id	Organization identifier to scope the query (number)

These properties allow fine-tuning the request to get exactly the subset of users or contacts needed.

Output

The node outputs JSON data containing the retrieved users and contacts matching the query parameters. The structure typically includes user details such as identifiers, names, emails, and user types. The exact fields depend on the external API's response schema.

If binary data were involved (e.g., profile pictures), it would be included in a separate binary output field, but this operation focuses on JSON user data only.

Dependencies

Requires an API key credential for authentication with the external ticketing system.
Needs the base URL of the API configured in the node credentials.
Depends on the external ticketing system's REST API endpoint that supports querying users and contacts with the specified parameters.

Troubleshooting

Empty results: Verify that the query parameters like userType, searchCriteria, or clientId are correctly set and correspond to existing data.
Authentication errors: Ensure the API key credential is valid and has sufficient permissions.
Pagination issues: If using anchorNaturalId for pagination, confirm that the value corresponds to a valid last user ID from the previous page.
Invalid parameter values: Check that numeric fields like pageSize and clientId are numbers and within allowed ranges.

Links and References

Refer to the external ticketing system’s API documentation for detailed descriptions of query parameters and response formats.
n8n documentation on how to configure API credentials and use collection-type input properties.