API Queries - List Folders
The list_folders function lists folders in your Monetization account and their settings. Additional parameters are optional for this function.
Additional Parameters
- folder - The name of the folder. If this parameters is omitted, all folders in your account will be shown. (Optional)
Note: Make sure to URL encode all values.
Example query and response:
In this example, we will retrieve settings for the folder "parkeddomains" (folder=parkeddomains).
Example query:
https://www.above.com/api.php?username=user&password=pass&api_key=key&mode=list_folders&folder=parkeddomains
Response:
<results>
<resultauto_optimizer="0"domain_count="0"folder_id="22353"locked="0"maximizer="1"name="parkeddomains"service="{"setting1":{"park_id":"1","percent":60},"setting2":{"park_id":"1","percent":40}}"/>
</results>
Error Responses:
Possible error responses for this function are:
- 413 - Folder Not Found
- General errors, such as 200 - Internal Error or 300 - Username or password invalid.
For a complete list of error responses, see the Error Codes manual page.