Skip to content

Retrieve a list of lists in Inxmail Professional

GET /integrations/inxmail-professional/accessible-customers/{customerName}/lists

Request Parameters

Parameter Required In Description
customerName yes path The name of accessible customer
showAllLists no query Returns all available lists for the customer without any filtering or restrictions.

Response Structure

Path Type Description
id Number The ID of the list
name String The name of the list

Basic example

Request:

$ curl 'https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/accessible-customers/myka/lists' -i -X GET \
    -H 'Authorization: Basic <base64Encoded user:password>'

Response:

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: ...

{
   "_embedded" : {
      "inx:lists" : [
         {
            "_links" : {
               "self" : {
                  "href" : "https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/accessible-customers/myka/lists/3"
               }
            },
            "id" : 3,
            "name" : "Mailing List"
         }
      ]
   },
   "_links" : {
      "curies" : [
         {
            "href" : "https://apidocs.inxmail.com/nxp/rest/v1/relations/{rel}",
            "name" : "inx",
            "templated" : true
         }
      ],
      "self" : {
         "href" : "https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/accessible-customers/myka/lists"
      }
   }
}
Back to top