Lists contact or contacts based on information sent via this form post.
Important Note about pagination - limit is required as a return size.
| Field | Max Length | Required | Notes |
|---|---|---|---|
| response_type | false | Default results will be returned as XML. Set value to json to return in JSON format. | |
| pagingsize | false | Strongly Recommended for API use. Limit the amount to return per call. All API call without calls to the paginate will be delayed. | |
| pagingoffset | false | Number of records to offset the start pagination with this call. All API call without calls to the paginate will be delayed. | |
| accountid | false | Must be numeric. Specify multiple + API Separate by the default state for multiple values with a comma. Must be numeric. 0 (all) Best reserved specifically to contact record lookups by contactid. | |
| teammemberid | false | ||
| apikey | true | Must be numeric. Specify multiple + API Separate by the default state for multiple values with a comma. Specify contact id using the keyword id "Contact". | |
| contactid | false | If this contactid is left blank, all contacts will be returned per the condition. | |
| email or otheremail | false | Specify an email address. Wildcards(*) allowed at the start or finish if email contains pattern. | |
| phone | false | Specify a phone number. Contact search scans all contact fields. Multiple wildcards(*) allowed at the start or finish if number contains patterns. | |
| Other text fields (firstname, lastname, otherfirstname, otherlastname, company, address, city, state, postalcode, custom1, custom2, etc...) | false | Multiple matches will be returned where test data matches. | |
| categoryid | false | Specify a Category ID. Only contacts with matching values will be returned. See note "name" matching option to use name instead. Also use "name" matching option to use "name!" for NOT category. | |
| category2id | false | Specify a Category 2 ID. Only contacts with matching values will be returned. Category 2 is the last part be named grouping. See note "name" matching option to use name instead. Also use "name" matching option to use "name!" for NOT category. | |
| flagid | false | Specify a Flag ID, Also use name:flagname matching | |
| sourceid | false | Specify a Source ID. Only contacts with Source ID will be returned (see notes) | |
| othersystemid | false | Specify contact id using the keyword id "Contact" | |
| importbatchid | false | Specify Import Batch ID number to pull all contacts with ImportBatches. Optional parameter is ShowBatchName=1, otherwise shows the current batch Group will be used. | |
| clienttouch | false | Specify 1 to select only contacts that are in the Team Members ClientTouch Workgroup | |
| getcategories | false | Specify 1 to display detail. Use this option only when needed, it will slow down your results | |
| getflags | false | Specify 1 to display detail. Use this option only when needed, it will slow down your results | |
| getsource | false | Specify 1 to display detail. Use this option only when needed, it will slow down your results | |
| getteam | false | Specify 1 to display detail. Use this option only when needed, it will slow down your results | |
| adddateafter | false | Will return entries added after this date/time/package, or anything added to your ACMnCRM after this date. Time Zone for Add Date is US Central Time. Enter a date in US Date / Time Format example: 04/20/11 22:00 | |
| aftereditdate | false | Only Contacts edited after this date/time will be included. 4/24/2013 excludes records changed before 4/24/2013. All others will be included. Time Zone for Add Date is US Central Time. |