Ploomes CRMInstall

Summary

Retrieve multiple Contact records from the Ploomes CRM API with support for pagination, filtering, sorting, field selection, and expanding related entities. Supports flexible filtering via a visual builder or raw OData filter strings, and optional in-memory caching of GET responses during workflow runtime.

Inputs

• Cache Strategy — Select in-memory cache usage for the GET request (options: Disabled, Cache First, Fallback Only). Cache lasts while n8n runs.
• Cache TTL (Seconds) — Time-to-live in seconds for cached responses (default 300), used if cache enabled.
• $top (Limit) — Maximum number of Contact records to return (minimum 1, default 1).
• $skip (Offset) — Number of records to skip for paginated results (minimum 0, default 0).
• $select (Fields) — Comma-separated list of Contact fields to return (default 'Id').
• $orderby (Sort) — Field(s) to sort results by, including sort direction (default 'Id').
• Use Filter Builder — Choose to define filters visually or write raw OData $filter string.
• $filter (Raw) — Raw OData $filter expression if not using the visual filter builder.
• Filter Conditions — Visually build OData $filter conditions with fields, operators, and values
• Custom Property Filters — Filter contacts by custom field values under OtherProperties, combined with AND to main filter.
• Navigation Property Filters — Filter by navigation properties (one-to-many or direct) combined with AND to main filter.
• Use Expand Builder — Choose between visual builder or raw OData $expand string for expanding related entities.
• $expand (Raw) — Raw OData $expand expression if not using visual expand builder.
• Expand Relations — Visual selection of relation properties to expand with nested $select, $filter, or $expand.
• Expand Nested Filters — Visually build nested $filter conditions for expanded properties.

Output shape

multiple Contact records as individual items

Returns an item for each Contact record satisfying the query parameters. If caching is enabled, cached data may be returned with annotation flags (_fromCache, _fallback). Supports pagination via $top and $skip. If no records match, returns no items.

Examples

Example 1: Retrieve up to 10 Contacts whose Name starts with 'John', including Owner details with selected fields, sorted by Name ascending, using cache first with 5-minute TTL.

Set $top to 10, Use Filter Builder with a condition Field 'Name', Operator 'Starts With', Value 'John'. Expand Relations includes 'Owner' with $select 'Id,Name'. Set $orderby to 'Name asc'. Cache Strategy set to 'cacheFirst' with Cache TTL 300 seconds.

Links

• n8n community nodes installation guide