Simple
Email Marketing
Platform

Open a Mailpro account and enjoy
100 FREE Credits

Mailpro API

List

Description

Get a listing of all Address Books.

Method

Get

Call

Base URL
https://api.mailpro.com/v2/addressbook/list.xml
Name Mandatory Description
IDClient
YES
This is a unique ID to identify the client
APIKey
YES
This is a GUID to identify the client and to access the API
TitleFilter
NO
Text to filter the results
Type
NO
If present, only unsubscription address books (1)
or subscription address books (0) are returned
NumberOfRecords
NO
Default All. If PageNumber is used, it determines the page size
(number of records per page)
PageNumber
NO
Indicates the requested page number. It’s necessary to use with the
parameter NumberOfRecords
SortByName
NO
Default false (and then sort by Creation Date Desc)

Result

API list address book

Result Attributes

Name
Description
AddressBooks[] Contains list of address books
    AddressBook[] Identify each address book
        AddressBookId ID of the address book
        CreationDate Creation date of this address book
Format : YYYY-MM-DDThh:mm:ss (ISO format)
        Title Title of address book
        Type 1 for Unsubscription address book
0 for subscription address book
        NumberEmails Number of emails in this address book
 

SIMPLE EMAIL MARKETING PLATFORM

Open a Mailpro account and enjoy 500 free credits