Actions30
- Account Actions
- Activity Actions
- Contact Actions
- Deal Actions
- GraphQL Actions
- Reporting Actions
- Webhook Actions
Deal → List by Stage
AI-generatedSummary
List deals by stage
Inputs
- pipelineId — Pipeline ID or name; can be an expression.
- stageId (required) — Stage ID to list deals from; can be an expression.
- dealSearchString — Optional search string to filter deals.
- dealPage — 0‑based page number.
- dealLimit — Maximum number of results (1‑100).
Output shape
an array of Deal objects
Pagination uses dealPage and dealLimit; an optional dealSearchString filters results; returns an empty array if no matches.
Examples
Example 1: Fetch first page of deals in the "Prospecting" stage
pipelineId = "MyPipeline" , stageId = "Prospecting" , dealPage = 0 , dealLimit = 50
Example 2: Search for deals containing "Acme" in a specific stage
pipelineId = "Sales" , stageId = "Negotiation" , dealSearchString = "Acme" , dealPage = 0 , dealLimit = 25