Ploomes CRM icon

Ploomes CRM

Interact with the Ploomes CRM API with full OData support

Actions126

Field Type → Get Many

AI-generated

Summary

Retrieves multiple Field Type records from Ploomes CRM using OData query options.

Inputs

  • cacheStrategy — How to use in-memory cache for GET requests. Options: Disabled (no cache), Cache First (use cached response if available and valid), Fallback Only (always fetch from API; use cache only if the request fails). Default: Disabled.
  • cacheTtl — Time-to-live for cached responses in seconds. Only applies when cacheStrategy is Cache First or Fallback Only. Default: 300 (5 minutes). Minimum: 1.
  • top — $top (Limit) – Maximum number of records to return. Default: 1. Minimum: 1.
  • skip — $skip (Offset) – Number of records to skip for pagination. Default: 0. Minimum: 0.
  • select — $select (Fields) – Comma-separated list of fields to return. Default: "Id". Example: Id,Name,Title.
  • orderby — $orderby (Sort) – Field to sort by with optional direction (asc/desc). Default: "Id". Example: Id desc, Name asc.
  • useFilterBuilder — Whether to use the visual filter builder (true) or write a raw OData $filter string (false). Default: true.
  • filterRaw — Raw OData $filter expression when Use Filter Builder is disabled. Example: Id eq 123 and Name eq 'John'. Default: empty string.
  • filterConditions — Visual filter conditions builder (array of condition objects) when Use Filter Builder is enabled. Each condition includes Field, Operator, Value, Value Type, and Logical Operator (AND/OR) to combine with the next condition.
  • customPropertyFilters — Filters by custom field values (OtherProperties) when Use Filter Builder is enabled. Each filter includes Field ID, Value Property, Operator, Value, and Value Is Numeric flag.
  • collectionFilters — Filters by navigation properties when Use Filter Builder is enabled. Each filter includes Filter Type (Collection (any) or Direct Navigation), Navigation Property, Field, Operator, Value, and Logical Operator (AND/OR) to combine with the next filter.
  • useExpandBuilder — Whether to use the visual expand builder (true) or write a raw OData $expand string (false). Default: true.
  • expandRaw — Raw OData $expand expression when Use Expand Builder is disabled. Example: OtherProperties,Owner($select=Id,Name). Default: empty string.
  • expandRelations — Visual expand relations builder (array of expansion objects) when Use Expand Builder is enabled. Each expansion includes Property Name, $select (Nested), Use Nested Filter, $filter (Nested), Use Nested Expand, and $expand (Nested).
  • expandNestedFilters — Visual nested filter builder for expanded properties when Use Expand Builder is enabled. Each nested filter includes Expansion Property (must match a property name in Expand Relations), Field, Operator, Value, Value Is Numeric, and Logical Operator (AND/OR) to combine with the next condition for the same expansion.

Output shape

array of Field Type objects (or empty array if no matches)

Each object contains the fields selected via $select (default: Id). When $expand is used, related entities are included according to the expand configuration. If caching is enabled and a cached response is used, each item includes _fromCache: true (and possibly _fallback: true if served from cache after a request failure). Errors are routed to the error output; timeouts to the timeout output.

Examples

Example 1: Get the first 5 Field Type records, selecting Id and Name, sorted by Name ascending.

{ top: 5, skip: 0, select: 'Id,Name', orderby: 'Name asc' }

Links

Discussion