How to obtain the mailing lists to show on a website

To obtain a mailing list, use the following URL.

 Method URL
 POST  https://api.fairwarningsoftware.com/v1.1.1/maillist

 

 Status Response
 200 {
    "categories":
        [
            {
                 <category_id> :
                     {
                         "category_name" : <category_name>,
                         "lists" :
                             {
                                 [
                                     "list" :
                                         {
                                             "list_id" : <list_id>,
                                             "list_safe_name" : <list_safe_name>,
                                             "list_website_name" : <list_website_name>
                                         }
                                 ]
                            }
                   }
           }
       ]
}
401  {"error":"The API keys provided are invalid."}
403  {"error":"API keys are missing."}
500  {"error": <custom error>}

 

 Field  Type Description
category_id int The ID of the mailing list category.
category_name string The name of the mailing list category.
lists object An object containing the category associated mailing lists.
list object An object containing the mailing list information.
list_id int The ID of the mailing list.
list_safe_name string The safe-name to be passed back when that item is selected.
list_website_name string The name to be displayed on the website for that mailing list.