folder:list

How to retrieve a list of the existing domain folders

Domain folders are virtual folders associated with your domain names that help you categorize and organize your domains. Using folders, you can stay organized and make certain changes to many domains at once.

You can retrieve the list of the existing domain folders by using the API request below. During the registration of a new domain, you can automatically put this domain in a specific folder by adding the tag domain:folderid to your domain:create request.

XML Template
<?xml version="1.0" encoding="UTF-8"?>
<request xmlns:folder="http://www.eurodns.com/folder">
    <folder:list/>
</request>

<folder:list> (Occurences: 1)

If the action was successful, the following code will be returned:
<?xml version="1.0" encoding="UTF-8"?>
<response xmlns:folder="http://www.eurodns.com/folder">
    <result code="1000">
        <msg>Command completed successfully</msg>
    </result>
    <resData>
        <folder:list numElements="#LISTCOUNTER#">
            <folder:data>
                <folder:name>#FOLDER NAME#</folder:name>
                <folder:id>#FOLDER ID#</folder:id>
                <folder:parentid>#FOLDER PARENT FOLDER ID#</folder:parentid>
                <folder:subfolders>#FOLDER SUBFOLDERS#</folder:subfolders>
            </folder:data>
        </folder:list>
    </resData>
</response>

<folder:list> (Occurences: 1)
R #LISTCOUNTER# The total number of existing folders
<folder:data> (Occurences: 0+)
R #FOLDER NAME# The name of the folder
R #FOLDER ID# The identifier of the folder
O #FOLDER PARENT FOLDER ID# The identifier of the parent folder (may be empty)
R #FOLDER SUBFOLDERS# The subfolders of the folder (folder:data structure)

Legend
O The element is optional an does not have to be specified in the request and/or answer
R The element is mandatory and has to specifed in the request and/or answer