Input fields

assignedToAffiliateNumber : String

Filter opportunities by assigned to affiliate number.
assignedToTeam : String

Filter opportunities by assigned to team.
Deprecation
The 'assignedToTeam' field is deprecated.

Please use 'assignedToTeamIdentifier' instead.

- Marked as deprecated on 2026-04-22.
- Scheduled for removal on or after 2026-06-22.
assignedToTeamIdentifier : String

The identifier of the team the leads are assigned to.
assignedToUserIdentifier : String

The identifier of the user the leads are assigned to.
createdAfter : DateTime

Filter opportunities created at or after this datetime (inclusive).
createdBefore : DateTime

Filter opportunities created before this datetime (exclusive). Together, createdAfter and createdBefore represent the [createdAfter, createdBefore) interval.
email : String

Filter opportunities by contact email address. This filter is ignored when freeText is a valid email.
freeText : String

Search opportunities by opportunity number, customer name, email, phone number, or national ID. If freeText is a valid email and email is also provided, the email from freeText takes precedence.
funnelCode : String

Filter opportunities by funnel code.
landlineNumber : String

Filter opportunities by contact landline number.
leadNumber : String

Filter opportunities by lead number.
phoneNumber : String

Filter opportunities by contact phone number.
productOfferingId : String

Filter opportunities by product offering identifier.
salesChannel : String

Filter opportunities by sales channel.
stageCode : String

Filter opportunities by stage.
supplyPointMarkets : [SupplyPointMarketNameEnum]

Filter opportunities by supply point markets.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "assignedToAffiliateNumber": "central-expert-pick-clear-feel", "assignedToTeamIdentifier": "99517532", "assignedToUserIdentifier": "46138016", "createdAfter": "1981-08-15T02:36:34.850706+00:00", "createdBefore": "1979-06-02T13:10:29.954948+00:00", "email": "draw-hour-admit-officer-practice", "freeText": "your-someone-happen-toward-nature", "funnelCode": "later-camera-look-family-establish", "landlineNumber": "own-new-large-investment-game", "leadNumber": "paper-size-maybe-experience-food", "phoneNumber": "stand-thought-success-different-society", "productOfferingId": "90849933", "salesChannel": "us-garden-his-produce-compare", "stageCode": "recent-such-cover-sense-population", "supplyPointMarkets": "GBR_ELECTRIC_JUICE" }