API reference
Help CenterCommunityDevelopersAcademyStatus

Get a list of databases - GetLists

Extract a list of Acoustic Campaign databases for an organization.

Elements (Required)

VISIBILITY - Defines the visibility of the returning databases: 0 (Private) or 1 (Shared).

LIST_TYPE - Defines the returning entity type:

  • 0 - Databases
  • 1 - Queries
  • 2 - Databases, Contact Lists, and Queries
  • 5 - Test Lists
  • 6 - Seed Lists
  • 13 - Suppression Lists
  • 15 - Relational Tables
  • 18 - Contact Lists

Elements (Optional)

FOLDER_ID - Specifies a particular folder from where to return databases.

INCLUDE_ALL_LISTS - Specify True or False to return all databases within subfolders. Note: Acoustic Campaign ignores the FOLDER_ID element if set to True.

INCLUDE_TAGS - Returns all tags associated with the database.

<Envelope>
  <Body>
    <GetLists>
      <VISIBILITY>0</VISIBILITY>
      <LIST_TYPE>2</LIST_TYPE>
    </GetLists>
  </Body>
</Envelope>

<Envelope>
  <Body>
    <RESULT>
      <SUCCESS>TRUE</SUCCESS>
      <LIST>
        <ID>365333</ID>
        <NAME>Folder One</NAME>
        <TYPE>0</TYPE>
        <SIZE>0</SIZE>
        <NUM_OPT_OUTS>0</NUM_OPT_OUTS>
        <NUM_UNDELIVERABLE>0</NUM_UNDELIVERABLE>
        <LAST_MODIFIED>08/23/07 04:18 PM</LAST_MODIFIED>
        <VISIBILITY>0</VISIBILITY>
        <PARENT_NAME/>
        <USER_ID>8c3747-111fae2b32c21fbca0cb8d6</USER_ID>
        <PARENT_FOLDER_ID>285607</PARENT_FOLDER_ID>
        <IS_FOLDER>true</IS_FOLDER>
      </LIST>
      <LIST>
        <ID>323543</ID>
        <NAME>List One</NAME>
        <TYPE>0</TYPE>
        <SIZE>1</SIZE>
        <NUM_OPT_OUTS>0</NUM_OPT_OUTS>
        <NUM_UNDELIVERABLE>0</NUM_UNDELIVERABLE>
        <LAST_MODIFIED>09/26/07 10:31 AM</LAST_MODIFIED>
        <VISIBILITY>0</VISIBILITY>
        <PARENT_NAME/>
        <USER_ID>8c3747-111fae23972-f520cb8d6</USER_ID>
        <PARENT_FOLDER_ID>285607</PARENT_FOLDER_ID>
        <IS_FOLDER>false</IS_FOLDER>
      </LIST>
      <LIST>
        <ID>390254</ID>
        <NAME>List two</NAME>
        <TYPE>0</TYPE>
        <SIZE>65</SIZE>
        <NUM_OPT_OUTS>0</NUM_OPT_OUTS>
        <NUM_UNDELIVERABLE>0</NUM_UNDELIVERABLE>
        <LAST_MODIFIED>09/26/07 10:31 AM</LAST_MODIFIED>
        <VISIBILITY>0</VISIBILITY>
        <PARENT_NAME/>
        <USER_ID>8c3747-111ae23d624dbca0cb8d6</USER_ID>
        <PARENT_FOLDER_ID>285607</PARENT_FOLDER_ID>
        <IS_FOLDER>false</IS_FOLDER>
      </LIST>
    </RESULT>
  </Body>
</Envelope>

🚧

LIST_TYPE input 5, 6, or 13 and LIST_TYPE 10

If your LIST_TYPE input is 5, 6, or 13 and you have at least one folder, element Type 10 appears in your list response.
If you include LIST_TYPE 10 in your request, all Seeds, Suppression, and Test lists return based on your VISIBILITY specification.

Elements (Results)

SUCCESS - True if successful, False if not.

LIST - XML nodes that define each database.

The following elements are children of LIST

ID - Returns the unique ID of the entity.

NAME - Returns the name of the entity.

TYPE - Returns the type: 0 (Databases), 1 (Queries), 2 (Both databases and queries), 5 (Test lists), 6 (Seed lists), 13 (Suppression lists), and 15 (Relational tables).

SIZE - Returns the number of contacts in the database.

NUM_OPT_OUTS - Returns the number of opted-out contacts in the database.

NUM_UNDELIVERABLE - Returns the number of undeliverable contacts in the database.

LAST_MODIFIED - Returns the date and time when the database was last modified.

VISIBILITY - Returns the visibility of the database (i.e. Shared or Private).

PARENT_NAME - Returns the name of the associated parent database.

USER_ID - Returns the User ID for the database owner.

PARENT_FOLDER_ID - Returns the ID of the folder where the database resides.

IS_FOLDER - Returns True if the entity is a folder rather than a database, query, or relational table.

FLAGGED_FOR_BACKUP - Indicates if the database is flagged for export by using the Automated backup functions.

SUPPRESSION_LIST - The ID of the associated Suppression list. The element is 0 if no Suppression list is associated.

Tags - If INCLUDE_TAGS is specified, returns any tags associated with the database.
Tag - A child element of Tags. The XML nodes that contain the tags associated with the database.