Actions30
- Account Actions
- Activity Actions
- Contact Actions
- Deal Actions
- GraphQL Actions
- Reporting Actions
- Webhook Actions
Deal → Get Deals by Filter Group
AI-generatedSummary
Fetch deals filtered by a user‑owned filter group, optionally limited to a pipeline stage and search string.
Inputs
- filterAuthInfo — Filter groups are owned by the user and require user login. API keys cannot access user filter groups. Change the credentials for this process.
- filterGroupId (required) — Saved filter group (requires Bearer token auth). Choose from the list, or specify an ID using an expression.
- pipelineId (required) — Restrict to this pipeline. Choose from the list, or specify an ID using an expression.
- stageId (required) — Restrict to this stage (within the selected pipeline). Choose from the list, or specify an ID using an expression.
- dealSearchString — Search string to filter deals.
- dealPage — Page number of results (0‑based).
- dealLimit — Maximum number of results to return (1–100).
Output shape
array of deal objects
Results are paginated; may include additional pagination metadata but only deal records are returned.
Examples
Example 1: Retrieve the first page of deals filtered by a specific filter group and stage
filterGroupId set to a saved group, pipelineId optional, stageId set to a stage, dealPage 0, dealLimit 50
Example 2: Search deals with a keyword and get up to 20 results
dealSearchString entered, dealLimit 20, dealPage 0