Fireberry icon

Fireberry

Consume Fireberry API

Query

AI-generated

Overview

The Fireberry node's Query operation allows users to retrieve records from Fireberry by specifying an object type and building a query either visually or using advanced query syntax. It supports selecting specific fields to return, sorting results, limiting the number of records, and choosing whether to return records as individual items or as an array. This operation is useful for extracting data from Fireberry based on complex conditions, enabling integration and automation workflows that require filtered data retrieval.

Use Case Examples

  1. Retrieve all customer records where the status is 'active' and sort them by last modified date.
  2. Query product inventory records with specific field conditions using the visual query builder.
  3. Use an advanced query string to fetch records matching complex criteria.

Properties

Name Meaning
Object Type Name or ID The Fireberry object type to query, selected from a list or specified by ID.
Fields Names or IDs The specific fields of the object to return in the query results, selectable or specified by ID.
Query Type Method to create the query, either using a visual query builder or writing an advanced query string.
Query The Fireberry query string used when Query Type is 'Advanced Query'.
Flattened Query Builder A collection of query items to build a flattened query with field conditions and logical operators when using the visual query builder.
Sort By Name or ID Field to sort the query results by.
Sort Type Sort order, ascending or descending.
Record Limit Maximum number of records to return; empty means all records.
Show Real Value Whether to show real values instead of only IDs for dropdown and lookup fields.
Return as Items Whether to return each record as a separate item instead of an array, useful for processing records individually.

Output

JSON

  • json
    • records - Array of records returned by the query.
    • returnAsItems - Flag indicating if records are returned as individual items.

Dependencies

  • Fireberry API credentials required for authentication.

Troubleshooting

  • Ensure the object type and fields specified exist in Fireberry to avoid errors.
  • If using advanced query syntax, verify the query string is correctly formatted according to Fireberry's query language.
  • Batching options should be configured carefully to avoid hitting Fireberry API rate limits.

Discussion