Actions125
- Ticket Actions
- Ticket Note Actions
- Ticket Attachment Actions
- Company Actions
- Company Note Actions
- Company Attachment Actions
- Contact Actions
- Resource (Employee) Actions
- Contract Actions
- Contract Note Actions
- Project Actions
- Project Note Actions
- Task Actions
- Task Note Actions
- Time Entry Actions
- Configuration Item Actions
- Configuration Item Note Actions
- Product Actions
- Opportunity Actions
- Quote Actions
- Quote Item Actions
- Service Call Actions
- Invoice Actions
- Subscription Actions
- Inventory Item Actions
- Purchase Order Actions
- Purchase Order Item Actions
Opportunity → List Opportunities
AI-generatedSummary
List matching Opportunities with optional filters and pagination.
Inputs
- returnAll — Whether to ignore Limit and return all matching records.
- limit — Maximum number of results to return when returnAll is false.
- includeFields — Comma-separated list of fields to include in each returned Opportunity (e.g., "id,name,stage"). Leave blank to include all fields.
- qfTitleContains — Partial match on the Opportunity title.
- qfCompanyID — Company ID to filter Opportunities by.
- qfOwnerResourceID — Resource (employee) ID who owns the Opportunity.
- qfStage — Opportunity stage filter; can select multiple stages.
- qfStatus — Opportunity status filter; can select multiple statuses.
- qfCreatedAfter — Filter Opportunities created on or after this datetime.
- qfCreatedBefore — Filter Opportunities created on or before this datetime.
- useAdvancedFilters — Toggle to enable advanced filter UI components.
- advancedFilters — Array of filter clause objects (field, operator, value) defining complex AND conditions.
- filterJson — Raw JSON filter array for advanced or OR logic; merged with other filters.
- requestOptions — Collection of HTTP header or impersonation overrides for the request.
Output shape
an array of Opportunity objects (or a paginated subset thereof)
When returnAll is false, results are limited by limit; pagination may return additional pages via subsequent calls. Optional fields can be included via includeFields; otherwise all fields are returned.
Examples
Example 1: Retrieve up to 50 recent Opportunities created after Jan 1 2023
resource=Opportunity,operation=getMany,limit=50,qfCreatedAfter=2023-01-01
Example 2: List all Opportunities owned by a specific resource
resource=Opportunity,operation=getMany,qfOwnerResourceID=12345,returnAll=true
Example 3: Fetch Opportunities with title containing 'Acme' and include only id and stage
resource=Opportunity,operation=getMany,qfTitleContains=Acme,includeFields=id,stage
