Overview
This node enables searching records within a specified object in the Knack platform. It allows users to query data stored in Knack objects by applying complex filters, sorting, and pagination controls. This is useful for workflows that need to retrieve specific subsets of data based on dynamic criteria, such as filtering customer records by status, date ranges, or other field values.
Practical examples include:
- Retrieving all active customers who signed up within the last month.
- Searching for orders with a total amount greater than a certain value.
- Filtering support tickets by priority and assigned agent.
The node handles pagination automatically to return up to the maximum number of results specified.
Properties
| Name | Meaning |
|---|---|
| Object | Select the Knack object to search records in. The list is dynamically loaded from the connected Knack application. |
| Filters | Define filter conditions to narrow down search results. Supports grouping conditions with AND/OR logic. Each condition specifies a field, operator (e.g., equals, contains), and a value or range depending on field type. |
| Max Results | Maximum number of records to return. The node will paginate through results automatically up to this limit. |
| Sort Field | Field to sort the results by. Options are dynamically loaded based on the selected object. |
| Sort Order | Sort direction: Ascending or Descending. |
| Additional Options | Extra options including: • Include Field Keys: Whether to duplicate field values with a "_raw" suffix (e.g., "Name": "John", "Name_raw": "John"). Defaults to true. |
Filters Details
- Match: Choose how multiple conditions combine — either all must match (AND) or any can match (OR).
- Conditions: Multiple filter conditions can be added. Each condition includes:
- Field: The field to filter on.
- Operator: Comparison operator, dynamically loaded based on the field type (e.g., is, is not, contains, is blank).
- Value: The value to compare against (hidden for operators like "is blank").
- Boolean Value: For boolean fields, select true or false.
- Date Range: For date/time fields with certain operators, specify days/weeks/months/years for relative date filtering.
Output
The output consists of JSON objects representing the matched records. Each record's fields are mapped to their human-readable labels. If the "Include Field Keys" option is enabled, each field value is duplicated with a _raw suffix containing the raw data.
Example output structure for a single record:
{
"id": "record_id",
"Customer Name": "John Doe",
"Customer Name_raw": "John Doe",
"Status": "Active",
"Status_raw": "Active",
...
}
No binary data is output for the search operation.
Dependencies
- Requires an API key credential for authenticating with the Knack API.
- Needs access to the Knack application ID and REST API key configured in the node credentials.
- The node makes HTTP requests to the Knack API endpoints to fetch objects, fields, and records.
Troubleshooting
- Authentication Errors: Ensure the API key credential is correctly configured with valid application ID and API key.
- Invalid Object or Field: Selecting an object or field that does not exist or is inaccessible will cause errors. Refresh the object and field lists if needed.
- Filter Syntax Issues: Incorrectly configured filters (e.g., missing values for required operators) may result in API errors.
- Max Results Limit: Setting a very high max results number may slow down execution due to pagination; consider limiting the number.
- Network Issues: Connectivity problems with the Knack API endpoint will cause request failures.
- Error Messages: The node returns error messages from the API or internal exceptions. Use the message details to identify issues such as permission problems or invalid parameters.
To resolve most issues, verify credentials, check object and field selections, and ensure filter conditions are properly defined.