Retrieve Subscribers (List Bulk Async)

Method

To retrieve all subscribers on a list, use the following syntax:

<system>
    <system_name>list</system_name>
    <action>BulkAsync</action>
    <sub_action>Subs_ToFTP</sub_action>
    <search_type>listid</search_type>
    <search_value>1234</search_value>
</system>

To filter by subscriber status, add the <search_status> tag, as follows:

<system>
    <system_name>list</system_name>
    <action>BulkAsync</action>
    <sub_action>Subs_ToFTP</sub_action>
    <search_type>listid</search_type>
    <search_value>1234</search_value>
    <search_status>Active<search_status>
</system>

With this call, you also have the option of picking up the resulting file from your own FTP site rather than from the ExactTarget secure FTP site, by including the <results> node in your call. See the Output for a Batch File Export (Bulk Async) Call help topic for the syntax to use.

Results

The immediate results of this call will be a confirmation message and the batch ID for this request, as described in Output for a Batch File Export (Bulk Async) Call. Use the batch ID to check on the status of the request; see Batch Inquire (Status Check).

The zipped file that will be deposited to the secure FTP site (or to your own FTP site, if you used the <results> node in your call) will contain the same XML output that you receive for the List Retrieve Subscribers method.