Client.Get

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

Les requêtes vers ce endpoint doivent être authentifiées avec une PartnerApiKey.

Retourne une collection des comptes clients gérés par votre compte partenaire.

Paramètres et infos requises

client_api_key - String
Optionnel. Une ClientApiKey, permet une recherche exacte pour retourner les informations d'un seul client.

name - String
Optionnel. Filtre sur le nom du compte, la recherche est effectuée comme un LIKE %% en SQL.

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 25 (Max.: 50)

Format des données en sortie

Un tableau d'objet, chaque objet représente un client.

[
  {
    "client_api_key": "b9ce325de7ba95ba143d23ba08e5e5a8",
	"name": "ACME",
	"company_name": "ACME Company",
	"address": "4453  Willison Street",
	"zipcode": "93610",
	"city": "Arlington",
	"credits_debit_mode": "THEIRS"
	"credit_balance" : 124526,
	"created_on": "2020-04-30T18:36:24+02:00",
	"emails": {
	  "main": "hello@acmeco.com"
	},
	"quotas": {
	  "allowed": 14253,
	  "consumed": 1425,
	  "next_reset": "2020-04-30T23:59:59+02:00"
	}	
  }
]