Ploomes CRMInstall

Summary

Retrieves multiple State records from Ploomes CRM with full OData query support and optional caching.

Inputs

• Cache Strategy — How to use in-memory cache for GET requests. Options: disabled (no cache), cacheFirst (use cached response if available and valid), fallbackOnly (always fetch from API; use cache only if the request fails). Default: disabled.
• Cache TTL (Seconds) — Time-to-live for cached responses in seconds. Only applies when Cache Strategy is cacheFirst or fallbackOnly. Default: 300 (5 minutes).
• $top (Limit) — Maximum number of records to return. Default: 1 (optimized for single‑item queries). Minimum: 1.
• $skip (Offset) — Number of records to skip for pagination. Default: 0. Minimum: 0.
• $select (Fields) — Comma‑separated list of fields to return. Default: Id. Example: Id,Name,Title
• $orderby (Sort) — Field to sort by with optional direction (asc/desc). Default: Id. Example: Id desc, Name asc
• Use Filter Builder — Toggle between visual filter builder and raw OData $filter string. Default: true (use builder).
• $filter (Raw) — Raw OData $filter expression when Use Filter Builder is off. Example: Id eq 123 and Name eq 'John'. Default: empty string.
• Filter Conditions — Visual filter builder conditions. Each condition includes Field, Operator, Value, Value Type, and Logical Operator (AND/OR) to combine with the next condition. Only shown when Use Filter Builder is true.
• Custom Property Filters — Filters on custom fields (OtherProperties). Each filter requires Field ID, Value Property (StringValue, IntegerValue, etc.), Operator, Value, and an optional Is Numeric flag. Combined with AND to the main filter. Only shown when Use Filter Builder is true.
• Navigation Property Filters — Filters on navigation properties (e.g., Lists, Tags, City, State, Owner). Each filter requires Filter Type (Collection (any) or Direct Navigation), Navigation Property name, Field, Operator, Value, and Logical Operator (AND/OR) to combine with the next filter. Combined with AND to the main filter. Only shown when Use Filter Builder is true.
• Use Expand Builder — Toggle between visual expand builder and raw OData $expand string. Default: true (use builder).
• $expand (Raw) — Raw OData $expand expression when Use Expand Builder is off. Example: OtherProperties,Owner($select=Id,Name). Default: empty string.
• Expand Relations — Visual expand builder configuration. Each expansion requires Property Name (navigation property to expand), optional $select (Nested) fields, optional Use Nested Filter/$filter (Nested), and optional Use Nested Expand/$expand (Nested). Only shown when Use Expand Builder is true.
• Expand Nested Filters — Visual builder for nested $filter conditions inside expansions. Requires Expansion Property (must match a property name in Expand Relations), Field, Operator, Value, Value Is Numeric flag, and Logical Operator (AND/OR) to combine with the next condition for the same expansion. Only shown when Use Expand Builder is true.

Output shape

three‑item array: [successData, errorData, timeoutData]

The node returns data on three output connections: Success, Error, and Timeout.

• Success: array of State objects matching the query. Each object contains the fields selected via $select (defaults to Id). When data is served from cache, each item includes _fromCache: true; when served from cache due to a fallback on request error, items also include _fromCache: true and _fallback: true.
• Error: array of error objects for non‑timeout failures (e.g., HTTP 4xx/5xx) when caching is disabled or unavailable. Each error object contains error message, statusCode, resource, operation, and timestamp.
• Timeout: array of timeout error objects (HTTP 408 or 504) when the request times out and continueOnFail is enabled.

If the node receives input items, it executes one request per item (though typically no input is supplied for a Get Many operation).

Examples

Example 1: Fetch the first 10 State records, sorted by Name ascending

Set $top to 10, $skip to 0, $select to Id,Name, $orderby to Name asc, leave filters empty.

Example 2: Retrieve State records where Name contains 'New' and cache results for 5 minutes

Set Cache Strategy to cacheFirst, Cache TTL to 300, use Filter Builder, add a condition: Field Name, Operator contains, Value New, Value Type Auto.

Example 3: Expand the Owner navigation property and select only Owner Id and Name

Set Use Expand Builder to true, add an expansion: Property Name Owner, $select (Nested) Id,Name.

Links

• n8n community nodes installation guide