Acumatica API - Endpoint Default 23 200 001Install

Summary

Retrieve Lead records matching specified filter criteria.

Inputs

• BusinessAccountFilter — Filter results by Business Account.
• CompanyNameFilter — Filter results by Company Name.
• ContactMethodFilter — Filter results by Contact Method.
• DoNotCallFilter — Filter results by Do Not Call.
• DoNotEmailFilter — Filter results by Do Not Email.
• DoNotFaxFilter — Filter results by Do Not Fax.
• DoNotMailFilter — Filter results by Do Not Mail.
• DuplicateFilter — Filter results by Duplicate.
• DuplicateFoundFilter — Filter results by Duplicate Found.
• EmailFilter — Filter results by Email.
• FaxFilter — Filter results by Fax.
• FaxTypeFilter — Filter results by Fax Type.
• FirstNameFilter — Filter results by First Name.
• JobTitleFilter — Filter results by Job Title.
• LanguageOrLocaleFilter — Filter results by Language Or Locale.
• LastIncomingActivityFilter — Filter results by Last Incoming Activity.
• LastNameFilter — Filter results by Last Name.
• LastOutgoingActivityFilter — Filter results by Last Outgoing Activity.
• LeadClassFilter — Filter results by Lead Class.
• LeadDisplayNameFilter — Filter results by Lead Display Name.
• LeadIDFilter — Filter results by Lead ID.
• NoMarketingFilter — Filter results by No Marketing.
• NoMassMailFilter — Filter results by No Mass Mail.
• OwnerFilter — Filter results by Owner.
• OwnerEmployeeNameFilter — Filter results by Owner Employee Name.
• ParentAccountFilter — Filter results by Parent Account.
• Phone1Filter — Filter results by Phone1.
• Phone1TypeFilter — Filter results by Phone1 Type.
• Phone2Filter — Filter results by Phone2.
• Phone2TypeFilter — Filter results by Phone2 Type.
• Phone3Filter — Filter results by Phone3.
• Phone3TypeFilter — Filter results by Phone3 Type.
• ReasonFilter — Filter results by Reason.
• SourceFilter — Filter results by Source.
• SourceCampaignFilter — Filter results by Source Campaign.
• StatusFilter — Filter results by Status.
• TitleFilter — Filter results by Title.
• WebSiteFilter — Filter results by Web Site.
• WorkgroupFilter — Filter results by Workgroup.
• WorkgroupDescriptionFilter — Filter results by Workgroup Description.
• LastModifiedDateTimeFilter — Filter results by Last Modified Date Time.
• ActiveFilter — Filter results by Active.
• DescriptionFilter — Filter results by Description.
• RefContactIDFilter — Filter results by Ref Contact ID.
• ConvertedByFilter — Filter results by Converted By.
• QualificationDateFilter — Filter results by Qualification Date.
• customFilter — Advanced OData $filter expression (e.g. CustomerID/value eq 'CUST001'). Applied in addition to any filter fields above.

Output shape

a list of Lead records

Results are returned as an array; pagination is not exposed; optional fields may be omitted.

Examples

Example 1: Get all active leads

'ActiveFilter' operator 'eq' value 'true'

Example 2: Filter leads by email containing 'example.com'

'EmailFilter' operator 'contains' value 'example.com'

Example 3: Advanced OData filter for leads created after a date

customFilter 'LeadCreatedOn/value gt 2024-01-01T00:00:00'

Links

• n8n community nodes installation guide