Acumatica API - Endpoint Default 24 200 001Install

Summary

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

Inputs

• Active Filter — Filter contacts by whether they are active (true or false).
• Override Account Address Filter — Filter contacts by the Override Account Address flag (true or false).
• Address Validated Filter — Filter contacts by whether the address has been validated (true or false).
• Attention Filter — Filter contacts by Attention field using specified string operator (equals, contains, starts with).
• Business Account Filter — Filter contacts by Business Account using specified string operator (equals, contains, starts with).
• Company Name Filter — Filter contacts by Company Name using specified string operator (equals, contains, starts with).
• Contact Class Filter — Filter contacts by Contact Class using specified string operator (equals, contains, starts with).
• Contact ID Filter — Filter contacts by Contact ID using numeric comparison operators (equals, greater than, less than, etc).
• Contact Method Filter — Filter contacts by Contact Method using specified string operator (equals, contains, starts with).
• Converted By Filter — Filter contacts by Converted By field using specified string operator (equals, contains, starts with).
• Date Of Birth Filter — Filter contacts by Date Of Birth using date comparison operators (equals, after, before, etc).
• Display Name Filter — Filter contacts by Display Name using specified string operator (equals, contains, starts with).
• Do Not Call Filter — Filter contacts by Do Not Call flag (true or false).
• Do Not Email Filter — Filter contacts by Do Not Email flag (true or false).
• Do Not Fax Filter — Filter contacts by Do Not Fax flag (true or false).
• Do Not Mail Filter — Filter contacts by Do Not Mail flag (true or false).
• Duplicate Filter — Filter contacts by Duplicate field using specified string operator (equals, contains, starts with).
• Duplicate Found Filter — Filter contacts by Duplicate Found flag (true or false).
• Email Filter — Filter contacts by Email using specified string operator (equals, contains, starts with).
• Fax Filter — Filter contacts by Fax using specified string operator (equals, contains, starts with).
• Fax Type Filter — Filter contacts by Fax Type using specified string operator (equals, contains, starts with).
• First Name Filter — Filter contacts by First Name using specified string operator (equals, contains, starts with).
• Gender Filter — Filter contacts by Gender using specified string operator (equals, contains, starts with).
• Image Filter — Filter contacts by Image field using specified string operator (equals, contains, starts with).
• Job Title Filter — Filter contacts by Job Title using specified string operator (equals, contains, starts with).
• Language Or Locale Filter — Filter contacts by Language or Locale using specified string operator (equals, contains, starts with).
• Last Incoming Activity Filter — Filter contacts by date/time of Last Incoming Activity using comparison operators.
• Last Modified Date Time Filter — Filter contacts by last modified date-time using comparison operators.
• Last Name Filter — Filter contacts by Last Name using specified string operator (equals, contains, starts with).
• Last Outgoing Activity Filter — Filter contacts by date/time of Last Outgoing Activity using comparison operators.
• Marital Status Filter — Filter contacts by Marital Status using specified string operator (equals, contains, starts with).
• Middle Name Filter — Filter contacts by Middle Name using specified string operator (equals, contains, starts with).
• No Marketing Filter — Filter contacts by No Marketing flag (true or false).
• No Mass Mail Filter — Filter contacts by No Mass Mail flag (true or false).
• Owner Filter — Filter contacts by Owner using specified string operator (equals, contains, starts with).
• Owner Employee Name Filter — Filter contacts by Owner Employee Name using specified string operator (equals, contains, starts with).
• Parent Account Filter — Filter contacts by Parent Account using specified string operator (equals, contains, starts with).
• Phone1 Filter — Filter contacts by Phone1 using specified string operator (equals, contains, starts with).
• Phone1 Type Filter — Filter contacts by Phone1 Type using specified string operator (equals, contains, starts with).
• Phone2 Filter — Filter contacts by Phone2 using specified string operator (equals, contains, starts with).
• Phone2 Type Filter — Filter contacts by Phone2 Type using specified string operator (equals, contains, starts with).
• Phone3 Filter — Filter contacts by Phone3 using specified string operator (equals, contains, starts with).
• Phone3 Type Filter — Filter contacts by Phone3 Type using specified string operator (equals, contains, starts with).
• Qualification Date Filter — Filter contacts by Qualification Date using date comparison operators.
• Reason Filter — Filter contacts by Reason using specified string operator (equals, contains, starts with).
• Source Filter — Filter contacts by Source using specified string operator (equals, contains, starts with).
• Source Campaign Filter — Filter contacts by Source Campaign using specified string operator (equals, contains, starts with).
• Spouse Or Partner Name Filter — Filter contacts by Spouse or Partner Name using specified string operator (equals, contains, starts with).
• Status Filter — Filter contacts by Status using specified string operator (equals, contains, starts with).
• Synchronize Filter — Filter contacts by Synchronize flag (true or false).
• Title Filter — Filter contacts by Title using specified string operator (equals, contains, starts with).
• Type Filter — Filter contacts by Type using specified string operator (equals, contains, starts with).
• Web Site Filter — Filter contacts by Web Site using specified string operator (equals, contains, starts with).
• Workgroup Filter — Filter contacts by Workgroup using specified string operator (equals, contains, starts with).
• Workgroup Description Filter — Filter contacts by Workgroup Description using specified string operator (equals, contains, starts with).
• Full Name Filter — Filter contacts by Full Name using specified string operator (equals, contains, starts with).
• Ext Ref Nbr Filter — Filter contacts by External Reference Number using specified string operator (equals, contains, starts with).
• Custom Filter — Advanced OData $filter expression applied in addition to specified filters.

Output shape

a list of Contact records matching the specified filters

The output returns matching Contact records; filters can be combined and a custom OData filter expression can be applied for advanced queries.

Examples

Example 1: Get all active contacts with 'Smith' in the last name

Set Active Filter to true and Last Name Filter operator to 'contains' with value 'Smith'.

Example 2: Retrieve contacts created after a specific date

Use the Last Modified Date Time Filter with operator 'after' and provide the date.

Links

• n8n community nodes installation guide