Acumatica API - Endpoint Default 25 200 001Install

Summary

Retrieve a list of Contact records from Acumatica filtered by specified criteria.

Inputs

• Active Filter — Filter results by whether contacts are Active (boolean). Operator supports equality.
• Override Account Address Filter — Filter results by Override Account Address (boolean). Operator supports equality.
• Address Validated Filter — Filter results by Address Validated status (boolean). Operator supports equality.
• Attention Filter — Filter results by Attention field (string), supporting operators: equals, contains, starts with.
• Business Account Filter — Filter results by Business Account (string), supporting operators: equals, contains, starts with.
• Company Name Filter — Filter results by Company Name (string), supporting operators: equals, contains, starts with.
• Contact Class Filter — Filter results by Contact Class (string), supporting operators: equals, contains, starts with.
• Contact ID Filter — Filter results by Contact ID (number), supporting operators: equals, greater than, greater or equal, less than, less or equal.
• Contact Method Filter — Filter results by Contact Method (string), supporting operators: equals, contains, starts with.
• Converted By Filter — Filter results by Converted By (string), supporting operators: equals, contains, starts with.
• Date Of Birth Filter — Filter results by Date Of Birth (dateTime), supporting operators: equals, after, on or after, before, on or before.
• Display Name Filter — Filter results by Display Name (string), supporting operators: equals, contains, starts with.
• Do Not Call Filter — Filter results by Do Not Call (boolean). Operator supports equality.
• Do Not Email Filter — Filter results by Do Not Email (boolean). Operator supports equality.
• Do Not Fax Filter — Filter results by Do Not Fax (boolean). Operator supports equality.
• Do Not Mail Filter — Filter results by Do Not Mail (boolean). Operator supports equality.
• Duplicate Filter — Filter results by Duplicate (string), supporting operators: equals, contains, starts with.
• Duplicate Found Filter — Filter results by Duplicate Found (boolean). Operator supports equality.
• Email Filter — Filter results by Email (string), supporting operators: equals, contains, starts with.
• Fax Filter — Filter results by Fax (string), supporting operators: equals, contains, starts with.
• Fax Type Filter — Filter results by Fax Type (string), supporting operators: equals, contains, starts with.
• First Name Filter — Filter results by First Name (string), supporting operators: equals, contains, starts with.
• Gender Filter — Filter results by Gender (string), supporting operators: equals, contains, starts with.
• Image Filter — Filter results by Image (string), supporting operators: equals, contains, starts with.
• Job Title Filter — Filter results by Job Title (string), supporting operators: equals, contains, starts with.
• Language Or Locale Filter — Filter results by Language Or Locale (string), supporting operators: equals, contains, starts with.
• Last Incoming Activity Filter — Filter results by Last Incoming Activity (dateTime), supporting operators: equals, after, on or after, before, on or before.
• Last Modified Date Time Filter — Filter results by Last Modified Date Time (dateTime), supporting operators: equals, after, on or after, before, on or before.
• Last Name Filter — Filter results by Last Name (string), supporting operators: equals, contains, starts with.
• Last Outgoing Activity Filter — Filter results by Last Outgoing Activity (dateTime), supporting operators: equals, after, on or after, before, on or before.
• Marital Status Filter — Filter results by Marital Status (string), supporting operators: equals, contains, starts with.
• Middle Name Filter — Filter results by Middle Name (string), supporting operators: equals, contains, starts with.
• No Marketing Filter — Filter results by No Marketing (boolean). Operator supports equality.
• No Mass Mail Filter — Filter results by No Mass Mail (boolean). Operator supports equality.
• Owner Filter — Filter results by Owner (string), supporting operators: equals, contains, starts with.
• Owner Employee Name Filter — Filter results by Owner Employee Name (string), supporting operators: equals, contains, starts with.
• Parent Account Filter — Filter results by Parent Account (string), supporting operators: equals, contains, starts with.
• Phone1 Filter — Filter results by Phone1 (string), supporting operators: equals, contains, starts with.
• Phone1 Type Filter — Filter results by Phone1 Type (string), supporting operators: equals, contains, starts with.
• Phone2 Filter — Filter results by Phone2 (string), supporting operators: equals, contains, starts with.
• Phone2 Type Filter — Filter results by Phone2 Type (string), supporting operators: equals, contains, starts with.
• Phone3 Filter — Filter results by Phone3 (string), supporting operators: equals, contains, starts with.
• Phone3 Type Filter — Filter results by Phone3 Type (string), supporting operators: equals, contains, starts with.
• Qualification Date Filter — Filter results by Qualification Date (dateTime), supporting operators: equals, after, on or after, before, on or before.
• Reason Filter — Filter results by Reason (string), supporting operators: equals, contains, starts with.
• Source Filter — Filter results by Source (string), supporting operators: equals, contains, starts with.
• Source Campaign Filter — Filter results by Source Campaign (string), supporting operators: equals, contains, starts with.
• Spouse Or Partner Name Filter — Filter results by Spouse Or Partner Name (string), supporting operators: equals, contains, starts with.
• Status Filter — Filter results by Status (string), supporting operators: equals, contains, starts with.
• Synchronize Filter — Filter results by Synchronize (boolean). Operator supports equality.
• Title Filter — Filter results by Title (string), supporting operators: equals, contains, starts with.
• Type Filter — Filter results by Type (string), supporting operators: equals, contains, starts with.
• Web Site Filter — Filter results by Web Site (string), supporting operators: equals, contains, starts with.
• Workgroup Filter — Filter results by Workgroup (string), supporting operators: equals, contains, starts with.
• Workgroup Description Filter — Filter results by Workgroup Description (string), supporting operators: equals, contains, starts with.
• Full Name Filter — Filter results by Full Name (string), supporting operators: equals, contains, starts with.
• Ext Ref Nbr Filter — Filter results by Ext Ref Nbr (string), supporting operators: equals, contains, starts with.
• Custom Filter — Custom OData $filter string (e.g. "OrderDate/value gt 2024-01-01T00:00:00") applied in addition to any above filters. Use this for advanced filtering logic not covered by predefined fields.

Output shape

a list of Contact records matching the specified filters

The operation returns an array of contact records filtered by any combination of the provided filters, including an optional advanced OData $filter expression in 'Custom Filter'. Filters with empty or default values are ignored. Operators supported depend on field types as specified. Returned data structure corresponds to Acumatica Contact entity representation.

Links

• n8n community nodes installation guide