Input fields

assignedToAffiliateNumber : String default: NotSupplied

Filter opportunities by assigned to affiliate number.
Deprecation
The 'assignedToAffiliateNumber' field is deprecated.

Lead-level assignment is being removed. Assignment is managed at Opportunity level.

- Marked as deprecated on 2026-05-19.
- Scheduled for removal on or after 2026-07-19.
assignedToTeam : String default: NotSupplied

The name of the team the leads are assigned to.
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 default: NotSupplied

The identifier of the team the leads are assigned to.
Deprecation
The 'assignedToTeamIdentifier' field is deprecated.

Lead-level assignment is being removed. Assignment is managed at Opportunity level.

- Marked as deprecated on 2026-05-19.
- Scheduled for removal on or after 2026-07-19.
assignedToUserIdentifier : String default: NotSupplied

The identifier of the user the leads are assigned to.
Deprecation
The 'assignedToUserIdentifier' field is deprecated.

Lead-level assignment is being removed. Assignment is managed at Opportunity level.

- Marked as deprecated on 2026-05-19.
- Scheduled for removal on or after 2026-07-19.
assignedToUsername : String default: NotSupplied

The username of the user the leads are assigned to.
Deprecation
The 'assignedToUsername' field is deprecated.

Please use 'assignedToUserIdentifier' instead.

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

The name of the organization the leads are created by.
Deprecation
The 'createdByOrganization' field is deprecated.

Please use 'assignedToAffiliateNumber' instead.

- Marked as deprecated on 2026-01-29.
- Scheduled for removal on or after 2026-03-27.
freeText : String

Free text field that will search against different identifiers of the lead. Currently supported include: lead number, phone number, email, name.
leadType : LeadTypeChoices

Filter leads by type.
stageCode : String

Filter leads by stage code.
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

{ "freeText": "box-find-gas-someone-election", "leadType": "BUSINESS", "stageCode": "effect-role-with-whole-it" }