Nexoid icon

Nexoid

Connect N8N to Nexoid via the Nexoid API. You will need an API service account which you can make inside the Nexoid Web Application (https://app.nexoid.com)
Join our community

Actions5

Overview

This node connects to the Nexoid API to perform operations on Nexoid records, specifically supporting searching records with flexible query filters, sorting, and pagination. It is useful for retrieving records from Nexoid databases based on complex search criteria, such as filtering contacts or invoices by specific fields, sorting by creation date, and optionally retrieving all matching records through scrolling.

Use Case Examples

  1. Search for all 'open' state records of type 'contact' with a specific query filter.
  2. Retrieve up to 100 records sorted by creation date in descending order.
  3. Automatically scroll through all search results to retrieve every matching record without manual pagination.

Properties

Name Meaning
Record type The object type to search within, similar to a table name in SQL (e.g., 'contact' or 'invoice'). This is required to specify which record type to query.
Query (JSON Format) The search filter expressed in Elasticsearch (AWS Opensearch) JSON syntax to specify criteria for matching records.
Sort Order Defines the sorting order of the search results using Elasticsearch JSON syntax. An empty array uses the default sort order.
Output Fields Specifies which fields to include in the output records, provided as a JSON array of field names.
Size The number of records to retrieve per request, with a minimum of 1 and maximum of 10,000.
Scroll (Retreive All) If true, the node will automatically paginate through all search results by sending multiple requests until all records are retrieved.

Output

JSON

  • records - Array of record objects matching the search criteria, each containing the requested output fields.

Dependencies

  • Nexoid API service account credentials including API URL, customer ID, username, and password for authentication.

Troubleshooting

  • Authentication failures due to invalid API user credentials will result in errors; ensure correct credentials are provided.
  • Invalid JSON format in the Query, Sort Order, or Output Fields properties can cause parsing errors; verify JSON syntax before execution.
  • If scrolling is enabled but the scroll ID is lost or invalid, the node may fail to retrieve all records; retrying the operation may help.

Links

Discussion