Ploomes CRM icon

Ploomes CRM

Interact with the Ploomes CRM API with full OData support

Actions126

Contact Origin → Get Many

AI-generated

Summary

Retrieves multiple contact origin records from Ploomes CRM's Contacts@Origins endpoint using OData query parameters ($top, $skip, $select, $orderby, $filter, $expand).

Inputs

  • cacheStrategy — How to use the in-memory GET cache. 'disabled' always calls the API; 'cacheFirst' returns a valid cached response when available; 'fallbackOnly' calls the API first and uses the cache only if the request fails.
  • cacheTtl — Seconds to keep a cached response. Default is 300. Only used when cacheStrategy is cacheFirst or fallbackOnly.
  • top — $top limit: maximum number of records to return. Default is 1, so increase this to retrieve more than one record.
  • skip — $skip offset: number of records to skip for pagination. Default is 0.
  • select — $select: comma-separated list of fields to return. Default is "Id". Example: Id,Name,Title.
  • orderby — $orderby: field to sort by, with optional direction. Default is "Id". Example: Id desc, Name asc.
  • useFilterBuilder — Whether to build $filter visually. When true (default), use filterConditions, customPropertyFilters, and collectionFilters. When false, use filterRaw.
  • filterRaw — Raw OData $filter expression, used when useFilterBuilder is false. Example: Id eq 123 and Name eq 'John'.
  • filterConditions — Visual filter conditions. Each condition has field, operator (eq, ne, gt, ge, lt, le, contains, startswith, endswith), value, valueType (auto/string/number/boolean/date/null), and logicalOperator (and/or). Auto mode leaves numeric-looking values unquoted and quotes everything else; string mode always quotes and escapes single quotes.
  • customPropertyFilters — Filters on custom field values stored in OtherProperties. Each entry uses fieldId, valueProperty (StringValue, IntegerValue, BigStringValue, BoolValue, DateTimeValue, or ObjectValueId), operator, value, and isNumeric. Generates OtherProperties/any(...) expressions combined with AND.
  • collectionFilters — Filters on navigation properties. filterType 'any' builds collection lambda filters such as Lists/any(l: l/ListId eq 123); filterType 'direct' builds single-property filters such as City/Id eq 3941. Each entry includes collection, field, operator, value, and logicalOperator.
  • useExpandBuilder — Whether to build $expand visually. When true (default), use expandRelations and expandNestedFilters. When false, use expandRaw.
  • expandRaw — Raw OData $expand expression, used when useExpandBuilder is false. Example: OtherProperties,Owner($select=Id,Name).
  • expandRelations — Related entities to expand. Each expansion has property, optional nested $select, optional nested $filter, and optional nested $expand. Multiple expansions are comma-separated in the request.
  • expandNestedFilters — Visual nested filter conditions for expanded properties. Each entry targets an expansionProperty, field, operator, value, isNumeric, and logicalOperator (default or). Conditions are grouped by expansion property and combined with any manual nested filter using AND.

Output shape

Success output emits one JSON item per record from the response value array; a non-array response is emitted as one item. Cached items include _fromCache: true; fallback-cache items also include _fallback: true. Empty responses produce { success: true, resource, operation, timestamp }. HTTP 408/504 failures go to the Timeout output; other failures go to the Error output with { error, statusCode, isTimeout, resource, operation, timestamp }.

Because the default $top is 1 and default $select is Id, the operation returns only one record containing only its Id unless you override those parameters.

Links

Discussion