Ploomes CRMInstall

Summary

Retrieves task types (Ploomes task categories) from the Ploomes CRM API via a GET to /Tasks@Types, with OData paging, field selection, sorting, filtering, expansion, and optional in-memory caching. Emits one n8n item per returned record.

Inputs

• $top (Limit) — Maximum records to return. Defaults to 1, so raise it to get more than one task type.
• $skip (Offset) — Number of records to skip, for pagination. Default 0, which omits the parameter.
• $select (Fields) — Comma-separated fields to return. Defaults to "Id", so only IDs come back unless you list more (e.g. Id,Name). Clear it to get all fields.
• $orderby (Sort) — Sort field with optional asc/desc. Default "Id".
• Use Filter Builder — Default true. Uses the visual builders below. If false, uses the raw $filter string instead.
• $filter (Raw) — Raw OData $filter expression, used when Use Filter Builder is off.
• Filter Conditions — Visual conditions of field, operator (eq, ne, gt, ge, lt, le, contains, startswith, endswith), value, value type (auto, string, number, boolean, date, null) and AND/OR joiner to the next condition. Auto mode leaves numbers unquoted and quotes everything else.
• Custom Property Filters — Filters on custom fields (OtherProperties) by field ID, value property, operator and value. Joined with AND to the rest of the filter.
• Navigation Property Filters — Filters on related entities, either Collection (any) lambdas or direct navigation paths. Joined with AND to the rest of the filter.
• Use Expand Builder — Default true. Uses the visual expand builder. If false, uses the raw $expand string.
• $expand (Raw) — Raw OData $expand expression, used when Use Expand Builder is off.
• Expand Relations — Navigation properties to expand, each with optional nested $select, nested $filter and nested $expand.
• Expand Nested Filters — Visual nested filters applied to a named expansion. The expansion property must match one in Expand Relations. They are combined with any manual nested filter using AND.
• Cache Strategy — Disabled (default), Cache First (return 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, keyed by URL and query, and lasts while n8n runs.
• Cache TTL (Seconds) — Cache entry lifetime in seconds, default 300. Shown only when caching is enabled.

Output shape

One item per task type record from the response's value array, sent to the first (Success) output. If the response is not an array wrapper, a single item holds the whole response. Items are plain Ploomes task type objects, limited to the $select fields (default Id only) and including any expanded properties.

The node has three outputs: Success, Error and Timeout. Failed requests produce items like {error, statusCode, isTimeout, resource, operation, timestamp}. They go to Error, or to Timeout for HTTP 408/504. Non-timeout errors stop the workflow unless Continue On Fail is set. Items served from cache carry _fromCache: true, and cache served after a failed request also carry _fallback: true. Fallback Only uses cache only when a request has failed and an entry exists. Defaults of $top=1 and $select=Id return a single ID-only record. Each input item triggers its own request, so the node runs once per incoming item. An empty response yields a {success, resource, operation, timestamp} item.

Examples

Example 1: List all task types with their names to populate a lookup

$top = 100, $select = "Id,Name", $orderby = "Name asc", no filters, cache strategy Cache First with TTL 3600.

Example 2: Find a task type by name

$top = 1, $select = "Id,Name", Filter Conditions: field Name, operator Equals (eq), value "Call", value type String.

Example 3: Page through task types using a raw filter

Use Filter Builder off, $filter (Raw) = "Id gt 10", $top = 50, $skip = 50, $select = "Id,Name".

Links

• n8n community nodes installation guide