NinjaOne icon

NinjaOne

Consume NinjaOne API

Actions158

Ticketing → Get Tickets By Board

AI-generated

Overview

This node operation "Get Tickets By Board" under the "Ticketing" resource is designed to retrieve tickets associated with a specific board from the NinjaOne API. It allows users to fetch ticket data filtered and sorted according to various criteria, supporting pagination and selective inclusion of columns.

Common scenarios where this node would be beneficial include:

  • Displaying or processing tickets related to a particular project board in an automated workflow.
  • Integrating ticket data into reporting tools or dashboards.
  • Automating ticket management tasks by fetching relevant tickets based on dynamic filters or search criteria.

Practical example:

  • A user wants to get all open tickets from board ID 123, sorted by creation date, including only certain columns like ticket status and priority, and process them further in their workflow.

Properties

Name Meaning
Board Id The numeric identifier of the board from which to retrieve tickets.
Sort By JSON object specifying sorting criteria for the tickets (e.g., sort by date, priority).
Filters JSON object defining filter conditions to narrow down the tickets returned (e.g., status).
Page Size Number indicating how many tickets to return per page (pagination size).
Search Criteria String used to perform text-based search within tickets.
Include Columns JSON array specifying which columns of ticket data to include in the response.
Last Cursor Id Numeric cursor ID used for pagination to fetch tickets after a certain point.

Output

The output is an array of JSON objects, each representing a ticket retrieved from the specified board. Each ticket object contains fields as defined by the API response, potentially filtered and limited by the "Include Columns" property.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the NinjaOne API using OAuth2 authentication.
  • The node depends on the NinjaOne API endpoint /v2/ticketing/boards/{boardId}/tickets (implied by the operation name and parameters).
  • Proper API credentials must be configured in n8n to authenticate requests.

Troubleshooting

  • Common issues:

    • Invalid or missing Board Id will cause the API request to fail.
    • Malformed JSON in "Sort By", "Filters", or "Include Columns" properties can lead to parsing errors.
    • Pagination parameters like "Page Size" and "Last Cursor Id" must be valid numbers; otherwise, the API may reject the request.
    • Network or authentication failures if the API key or OAuth token is expired or misconfigured.

  • Error messages:

    • Errors from the API will be returned in the json.error field if "Continue On Fail" is enabled.
    • Typical error messages might include "Unauthorized" (check API credentials), "Board not found" (verify Board Id), or "Invalid filter format" (correct JSON syntax).

Links and References

Discussion