RD Station CRM icon

RD Station CRM

Interact with RD Station CRM

Deal → Get Many

AI-generated

Summary

Retrieve multiple deals from RD Station CRM with options to filter, sort, and paginate results.

Inputs

  • Return All — Set to true to return all matching deals without limiting the number of results.
  • Limit — Maximum number of deals to return when 'Return All' is false; must be at least 1 (default 50).
  • Page Size — Number of deals to fetch per API page request, between 1 and 200 (default 25).
  • Filter By — Field to filter deals by, such as ID, name, rating, status, various date fields, related entity IDs, or custom fields.
  • Custom Field Slug — Slug for a custom field to filter by when 'Filter By' is set to 'Custom Field (Slug)'.
  • Use Match (~) — Use case-insensitive partial matching for the 'Name' filter.
  • Deal IDs — List of one or more deal IDs when filtering by ID.
  • Filter Value — Value to filter selected field by; will be quoted automatically if containing spaces.
  • Rating From — Minimum rating inclusive when filtering by rating.
  • Rating To — Maximum rating inclusive when filtering by rating.
  • Date From — Start date (inclusive) for date range filtering on date fields like created_at or closed_at.
  • Date To — End date (inclusive) for date range filtering on date fields.
  • Has Product — Boolean indicating if a deal must have associated products when filtering by presence of products.
  • Sort By — Field to sort the results by, such as name, rating, or various date fields.
  • Sort Direction — Sort order ascending or descending, applicable when a sort field is specified.

Output shape

a list of deal objects

Supports pagination internally to meet the limit or return all flag; the output corresponds to the JSON:API 'data' array response with deal records matching the criteria and sorted as specified.

Examples

Example 1: Retrieve up to 100 deals filtered by status 'won', sorted by 'closed_at' descending.

Set 'Return All' to false, 'Limit' to 100, 'Filter By' to 'Status', 'Filter Value' to 'won', 'Sort By' to 'Closed At', 'Sort Direction' to 'Descending'.

Links

Discussion