Ploomes CRMInstall

Summary

Retrieve multiple City records from the Ploomes CRM API with support for filtering, sorting, selecting fields, pagination, and expanding related entities. Options for in-memory caching and both visual and raw OData query building are available to customize the request.

Inputs

• Cache Strategy — How to use in-memory cache for GET requests; options are Disabled, Cache First, or Fallback Only.
• Cache TTL (Seconds) — Duration in seconds to keep responses in cache (default 300 seconds). Only applicable if caching is enabled.
• $top (Limit) — Maximum number of city records to return. Defaults to 1 for optimized queries.
• $skip (Offset) — Number of records to skip for pagination purposes, default is 0.
• $select (Fields) — Comma-separated list of City entity fields to include in the response; defaults to 'Id'.
• $orderby (Sort) — Field(s) to sort by with optional direction (asc or desc); default is 'Id'.
• Use Filter Builder — Choose to build filters visually or input raw OData $filter string.
• Filter Conditions — Visual builder to add multiple filter conditions combined by logical operators.
• Custom Property Filters — Add filters for custom fields identified by Field ID, combined with the main filter using AND.
• Navigation Property Filters — Apply filters on navigation properties either as collections (any) or direct navigations.
• $filter (Raw) — Raw OData $filter string, used if the filter builder is disabled.
• Use Expand Builder — Choose to build $expand parameters visually or input raw OData $expand string.
• Expand Relations — Visual builder to specify related entities to expand, with options for selecting fields, nested filters, and nested expansions.
• Expand Nested Filters — Visual builder to create nested filters for expanded relations.
• $expand (Raw) — Raw OData $expand string, used if the expand builder is disabled.

Output shape

a list of City records, each as a JSON object; supports pagination based on $top and $skip parameters.

If caching is enabled, returned records may include metadata fields '_fromCache' or '_fallback' to indicate cache usage. The operation returns each matching city item separately; errors and timeout responses are routed to distinct outputs. Filtering, sorting, selecting, and expansions conform to OData conventions as specified in inputs.

Examples

Example 1: Fetch up to 10 City records sorted by Name ascending, including Name and State fields, filtering for cities whose Name starts with 'San'.

Set $top to 10; $orderby to 'Name asc'; $select to 'Id,Name,State'; use Filter Builder enabled with a condition: Field='Name', Operator='startswith', Value='San'.

Links

• n8n community nodes installation guide