Ploomes CRMInstall

Summary

Retrieves deal pipelines from the Ploomes CRM (GET https://api2.ploomes.com/Deals@Pipelines) using OData query options for paging, field selection, sorting, filtering and expansion, with optional in-memory caching.

Inputs

• $top (Limit) — Maximum records to return. Defaults to 1, so raise it to get more than one pipeline. Minimum 1.
• $skip (Offset) — Number of records to skip, for pagination. Default 0 (not sent when 0).
• $select (Fields) — Comma-separated fields to return. Defaults to "Id", so only IDs come back unless you list more fields (e.g. Id,Name). If emptied, the parameter is omitted.
• $orderby (Sort) — Sort field with optional asc/desc. Default "Id".
• Use Filter Builder — Toggles between the visual filter builder (default on) and a raw OData $filter string.
• $filter (Raw) — Raw OData $filter expression, used when the filter builder is off (e.g. Id eq 123 and Name eq 'John').
• Filter Conditions — Builder mode. Repeatable conditions with field, operator (eq, ne, gt, ge, lt, le, contains, startswith, endswith), value, value type (auto, string, number, boolean, date, null) and an AND/OR connector to the next condition.
• Custom Property Filters — Builder mode. Filters on custom field values via OtherProperties/any(...) by field ID, value property, operator and value. Combined with AND to the other filters.
• Navigation Property Filters — Builder mode. Filters on related entities, either collection any() lambdas or direct navigation paths (e.g. Owner/Id eq 5), with an AND/OR connector. Combined with AND to the other filters.
• Use Expand Builder — Toggles between the visual expand builder (default on) and a raw $expand string.
• $expand (Raw) — Raw OData $expand expression, used when the expand builder is off (e.g. OtherProperties,Owner($select=Id,Name)).
• Expand Relations — Builder mode. Navigation properties to expand, each with optional nested $select, nested $filter and nested $expand.
• Expand Nested Filters — Builder mode. Nested filter conditions attached by name to an expansion in Expand Relations. They are ANDed with that expansion's manual nested filter.
• Cache Strategy — Disabled (default), Cache First (serve a valid cached response without calling the API), or Fallback Only (always call the API, use cache only if the request fails). The cache is in-memory and lasts until n8n restarts.
• Cache TTL (Seconds) — Cached response lifetime when caching is enabled. Default 300.

Output shape

One n8n item per pipeline record. If the API response has a value array, each element becomes its own item; otherwise the whole response is one item.

The node has three outputs: Success, Error and Timeout. Failed requests produce items on Error (or Timeout for HTTP 408/504) with error, statusCode, isTimeout, resource, operation and timestamp. A non-timeout error stops the workflow unless Continue On Fail is enabled. Items served from cache include _fromCache: true, and cache served after a failed request also include _fallback: true. An empty response yields a single item with success: true. Output contains only the fields in $select, which defaults to Id. There is no automatic pagination, so use $top and $skip.

Examples

Example 1: List all pipelines with their names

Set $top to 100, $select to "Id,Name", and leave the filters and expansions empty.

Example 2: Find a pipeline by name

Add a Filter Condition with Field "Name", Operator "Equals (eq)", Value "Sales", and set $select to "Id,Name".

Example 3: Fetch pipelines with their stages, cached for 10 minutes

Add an Expand Relation with Property Name "Stages", set $top to 50, set Cache Strategy to "Cache First" and Cache TTL to 600.

Links

• n8n community nodes installation guide