Ploomes CRMInstall

Summary

Retrieve multiple Document records from Ploomes CRM using OData query options, with support for filtering, selecting, ordering, pagination, expanding related entities, and optional caching.

Inputs

• resource (required) — Fixed to 'Document' for this operation.
• operation (required) — Fixed to 'Get Many' (getAll) for this operation.
• cacheStrategy — How to use in‑memory cache for GET requests. Options: disabled, cacheFirst, fallbackOnly. Default: disabled.
• cacheTtl — Time‑to‑live for cached responses in seconds (only applies when cacheStrategy is cacheFirst or fallbackOnly). Default: 300.
• top — Maximum number of records to return ($top). Default: 1.
• skip — Number of records to skip for pagination ($skip). Default: 0.
• select — Comma‑separated list of fields to return ($select). Default: 'Id'.
• orderby — Field to sort by with optional direction ($orderby). Default: 'Id'.
• useFilterBuilder — Whether to build the $filter visually (true) or provide a raw string (false). Default: true.
• filterRaw — Raw OData $filter expression when useFilterBuilder is false. Default: empty string.
• filterConditions — Visual filter builder conditions (array of field/operator/value/logicalOperator) when useFilterBuilder is true. Default: empty array.
• customPropertyFilters — Filters on custom fields (OtherProperties) when useFilterBuilder is true. Default: empty array.
• collectionFilters — Filters on navigation properties (Lists, Tags, City, etc.) when useFilterBuilder is true. Default: empty array.
• useExpandBuilder — Whether to build the $expand visually (true) or provide a raw string (false). Default: true.
• expandRaw — Raw OData $expand expression when useExpandBuilder is false. Default: empty string.
• expandRelations — Visual expand builder definitions (property, nested $select, nested filter, nested expand) when useExpandBuilder is true. Default: empty array.
• expandNestedFilters — Visual nested filter definitions for expanded properties when useExpandBuilder is true. Default: empty array.

Output shape

The node returns three output arrays: Success, Error, Timeout.

Success contains the retrieved Document objects (each as JSON). When caching is used, items include _fromCache:true. Error contains error objects with message, statusCode, etc. Timeout contains timeout error objects.

Examples

Example 1: Get the first 10 Documents, selecting Id and Name, ordered by Name ascending.

top: 10, select: 'Id,Name', orderby: 'Name asc', cacheStrategy: disabled.

Example 2: Retrieve Documents where the custom field with FieldId 5 (StringValue) equals 'Contract' and expand the Owner navigation property selecting Id and Name.

useFilterBuilder: true, filterConditions: [{field:'5', operator:'eq', value:'Contract', valueType:'auto'}], customPropertyFilters: [{fieldId:5, valueProperty:'StringValue', operator:'eq', value:'Contract', isNumeric:false}], useExpandBuilder: true, expandRelations: [{property:'Owner', select:'Id,Name'}].

Links

• n8n community nodes installation guide