Ploomes CRM icon

Ploomes CRM

Interact with the Ploomes CRM API with full OData support

Actions126

Document Template → Get Many

AI-generated

Summary

Retrieve document template records from Ploomes CRM with OData query parameters, filtering, expansion, and optional caching.

Inputs

  • Cache Strategy — Caching behavior: disabled (no cache), cacheFirst (use cached response if valid), fallbackOnly (always fetch, use cache only on failure). Default: disabled.
  • Cache TTL (Seconds) — Time-to-live for cached responses in seconds (only applies when Cache Strategy is cacheFirst or fallbackOnly). Default: 300.
  • $top (Limit) — Maximum number of records to return. Default: 1 (minimum: 1).
  • $skip (Offset) — Number of records to skip for pagination. Default: 0 (minimum: 0).
  • $select (Fields) — Comma-separated list of fields to return (e.g., Id,Name). Default: Id.
  • $orderby (Sort) — Field to sort by with optional direction (asc/desc). Example: Id desc. Default: Id.
  • Use Filter Builder — Whether to use the visual filter builder (true) or write a raw OData $filter string (false). Default: true.
  • Filter Conditions — Visual filter conditions (requires Use Filter Builder: true). Each condition includes Field, Operator, Value, Value Type, and Logical Operator (AND/OR) to combine with next condition.
  • $filter (Raw) — Raw OData $filter expression (requires Use Filter Builder: false). Example: Id eq 123 and Name eq 'John'.
  • Custom Property Filters — Filters for custom fields (OtherProperties), combined with AND to main filter (requires Use Filter Builder: true). Each filter includes Field ID, Value Property, Operator, Value, and Value Is Numeric.
  • Navigation Property Filters — Filters for navigation properties (e.g., Lists, Tags, City), combined with AND to main filter (requires Use Filter Builder: true). Each filter includes Filter Type (Collection/Any or Direct Navigation), Navigation Property, Field, Operator, Value, and Logical Operator (AND/OR).
  • Use Expand Builder — Whether to use the visual expand builder (true) or write a raw OData $expand string (false). Default: true.
  • Expand Relations — Related entities to expand (requires Use Expand Builder: true). Each expansion includes Property Name, $select (Nested), Use Nested Filter, $filter (Nested), Use Nested Expand, and $expand (Nested).
  • $expand (Raw) — Raw OData $expand expression (requires Use Expand Builder: false). Example: OtherProperties,Owner($select=Id,Name).
  • Expand Nested Filters — Visual nested $filter conditions for expanded properties (requires Use Expand Builder: true). Each filter includes Expansion Property (must match an expansion in Expand Relations), Field, Operator, Value, Value Is Numeric, and Logical Operator (AND/OR) for same expansion.

Output shape

Array of document template objects on success (output 0); error objects on failure (output 1); timeout objects on timeout (output 2).

By default, returns only the 'Id' field of one record due to $top=1 and $select=Id. To return more records or fields, adjust $top and $select. The Ploomes API returns an OData response with a 'value' array; the node outputs each item in that array as a separate object in the success data.

Examples

Example 1: Get first 5 document templates, returning Id and Name, sorted by Name ascending

$top: 5, $select: Id,Name, $orderby: Name asc

Links

Discussion