List.Get

URL https://api.dpmail.fr/json/List.Get.php

Retourne une collection des listes de contact disponibles dans le compte.

Paramètres et infos requises

List_Name - String
Optionnel. Filtre sur le nom de la liste. Correspond au SQL LIKE %%.

Created_Before - String
Optionnel. Filtre sur la date de création de la liste. Au format  ISO_8601. Soit basiquement AAAA-MM-JJ hh:mm:ss
Retournera les listes ayant été créées avant le moment mentionné.

Created_After - String
Optionnel. Filtre sur la date de création de la liste. Au format  ISO_8601. Soit basiquement AAAA-MM-JJ hh:mm:ss
Retournera les listes ayant été créées après le moment mentionné.

Sort_Field - String
Optionnel. Critère de tri des résultats. Soit created pour classer par date de création de la liste, soit name pour classer par nom. Valeur par défaut: created

Sort_Dir - String
Optionnel. Sens du tri des résultats. Soit ASC , soit DESC. Valeur par défaut: DESC

Start - Integer
Le numéro de la page à laquelle commencer - par défaut 0, la première page

Limit - Integer
Le nombre de résultat à retourner (par page) - par défaut 50 (Max.: 500)

Codes de retour

Succès

0: Success
Un tableau de données contenant les informations sur les différentes listes de contact correspondant aux critères de filtrages.

Erreur

8: Le filtre sur la date de création de la liste est dans un format incorrect
La date fournie n'est pas valide. Veuillez vous conformer aux règles du format ISO_8601.

Format de données

{
  "total": 5,
  "data": [
      {
        "ListID": "07125a0a755e4035971a955c6e62bc45",
        "name": "Liste de contact",
        "date_created": "2016-05-29 15:14:13",
        "optin_type": "SIMPLE",
        "stats": {
          "member_count": 521,
          "unsubscribe_count": 45,
          "cleaned_count": 28,
          "custom_field_count": 1,
          "segment_count": 7
        }
      },
      ...
  ]
}