Ploomes CRMInstall

Summary

Retrieves contact relationship records (the lookup list of relationship types) from Ploomes via a GET to /Contacts@Relationships on api2.ploomes.com, with OData query controls ($top, $skip, $select, $orderby, $filter, $expand) and optional in-memory caching.

Inputs

• $top (Limit) — Maximum records to return. Defaults to 1, so raise it to get more than one record. Minimum 1.
• $skip (Offset) — Number of records to skip, for manual pagination. Default 0. The node does not paginate automatically.
• $select (Fields) — Comma-separated fields to return. Defaults to "Id", so only IDs come back unless you add fields such as Id,Name.
• $orderby (Sort) — Sort field with optional asc/desc. Default "Id".
• Use Filter Builder — On by default. When on, the filter is built from Filter Conditions, Custom Property Filters and Navigation Property Filters. When off, the raw $filter string is used.
• $filter (Raw) — Raw OData $filter expression, e.g. Id eq 123. Shown and used only when Use Filter Builder is off.
• Filter Conditions — Repeatable field / operator / value rows. Operators: eq, ne, gt, ge, lt, le, contains, startswith, endswith. Value Type controls quoting (auto, string, number, boolean, date, null). Each row's Logical Operator (AND/OR) joins it to the next row.
• Custom Property Filters — Filters on custom fields (OtherProperties) by Field ID, value property, operator and value. They are ANDed with the other filters.
• Navigation Property Filters — Filters on related entities, either a collection any() lambda (e.g. Lists, Tags) or direct navigation (e.g. City/Id). They are ANDed with the main filter.
• Use Expand Builder — On by default. When on, $expand is built from Expand Relations and Expand Nested Filters. When off, the raw string is used.
• $expand (Raw) — Raw OData $expand expression, e.g. OtherProperties,Owner($select=Id,Name). Used only when Use Expand Builder is off.
• Expand Relations — Navigation properties to expand. Each can have a nested $select, a nested $filter and a nested $expand.
• Expand Nested Filters — Visual nested filter conditions attached to an expansion by property name. They are combined with any manual nested filter on that expansion.
• Cache Strategy — Disabled (default), Cache First (return an unexpired cached response without calling the API) or Fallback Only (always call the API and use the cache only if the request fails). The cache is in-memory and lasts until n8n restarts.
• Cache TTL (Seconds) — Cache lifetime in seconds. Default 300. Shown only when a cache strategy is enabled.

Output shape

One n8n item per record in the API's value array, with fields limited by $select (default Id only). If the response has no value array, a single item holds the whole response. A response with an empty body produces a {success, resource, operation, timestamp} item. The node has three outputs: Success, Error and Timeout.

Cached results carry _fromCache: true, and fallback-served results also carry _fallback: true. Errors are routed to the Error output (or Timeout for HTTP 408/504) as items with error, statusCode, isTimeout, resource, operation and timestamp. Timeouts never stop the workflow. Other errors throw unless Continue On Fail is enabled. There is no automatic pagination; use $top and $skip. Requires Ploomes API credentials (ploomesApi). The request runs once per input item.

Examples

Example 1: List all contact relationship types with their names

$top = 100, $select = Id,Name, $orderby = Name asc, no filters.

Example 2: Look up a relationship type by name

$select = Id,Name, $top = 1, Filter Conditions: Name eq 'Partner' (Value Type auto or string).

Example 3: Reuse a rarely changing lookup list across many runs

$top = 200, $select = Id,Name, Cache Strategy = Cache First, Cache TTL = 3600.

Links

• n8n community nodes installation guide