Filtering Contacts to Export
In the export call, API users can include the following parameters to filter the contacts to export:
Filtering Criteria | Query Details |
---|---|
Contact database | Include the Database ID for the database from which to extract the contacts. This parameter is required in all queries. |
Job Lists | Include a pipe-delimited list of job IDs to limit the contact records that are extracted to those who are associated with specific job lists. For example, a parameter of jobIds=JID_846054_1234|JID_846055_1234 will extract only contact records that include Job IDs of JID_846054_1234 or JID_846055_1234. |
Contact Lists | Include a pipe-delimited list of contact list IDs to limit the contact records that are extracted to those that are associated with specific contact lists. For example, a parameter of contactListIds=101|201|301 will extract only contact records that include contact lists with IDs of 101, 201, or 301. |
Event Lists | Include a pipe-delimited list of event list IDs to limit the contact records that are extracted to those that are associated with specific event lists. For example, a parameter of eventListIds=E834037|E828395 will extract only contact records that include event lists with IDs of E834037 or E828395. |
Global Statuses | Include a pipe-delimited list of global statuses to limit the contact records that are extracted to those that have a specific global status. For example, a parameter of globalStatuses=New|Engaged|Status3 will extract only contact records that have a current global status of New, Engaged, or Status3. |
List Statuses |
Include a pipe-delimited list of list statuses to limit the contact records that are extracted to those that have a specific list status. For example, a parameter of listStatuses=New|Engaged|Status3 will extract only contact records that have a current list status of New, Engaged, or Status3. |
Added On Date Range |
|
Updated On Date Range |
Include an "updated on" date range to include all contacts updated within a specific time frame; the request parameters to define the range are fromUpdatedOn and toUpdatedOn. You can specify the date and time to the second using the format yyyy-mm-dd or yyyy-mm-dd hh:mm:ss.
|