Actions148
- Action Plan Actions
- Action Plan Assignment Actions
- Appointment Actions
- Appointment Outcome Actions
- Appointment Type Actions
- Automation Actions
- Automation Assignment Actions
- Call Actions
- Custom Field Actions
- Deal Actions
- Deal Attachment Actions
- Deal Custom Field Actions
- Deal Pipeline Actions
- Email Marketing Campaign Actions
- Email Marketing Event Actions
- Email Template Actions
- Event Actions
- Group Actions
- Identity Actions
- Note Actions
- People Relationship Actions
- Person Actions
- Person Attachment Actions
- Pond Actions
- Reaction Actions
- Smart List Actions
- Stage Actions
- Task Actions
- Team Actions
- Team Inbox Actions
- Text Message Actions
- Text Message Template Actions
- Threaded Reply Actions
- Timeframe Actions
- User Actions
Deal → Get Many
AI-generatedSummary
Retrieve multiple deals with filtering, pagination, and sorting.
Inputs
- authentication — Authentication method for the API request. Defaults to API Key if not specified.
- returnAll — Whether to return all results or only up to a given limit. Defaults to false.
- limit — Maximum number of results to return. Applicable when returnAll is false. Minimum value is 1. Defaults to 50. Displayed only when returnAll is false, resource is deals, and operation is getAll.
- options — Filter, include, and sort configuration for the deal list request. All sub-options are optional and displayed under resource=deals, operation=getAll.
- sort — Sort rule applied to the results. Displayed under resource=deals, operation=getAll.
Output shape
array of deal objects
The operation returns a list of deals matching the specified filters, pagination, and sort configuration. Exact return shape is determined by the Follow Up Boss API.
Examples
Example 1: Get the first 10 active deals sorted by creation date descending.
authentication=apiKey, returnAll=false, limit=10, status=Active, sort.field=created, sort.direction=desc