Users.All

URL https://api.dpmail.fr/json/Users.GetAll.php

Retourne un résultat paginé contenant tous les utilisateurs qui ont accès au compte, ainsi que leurs permissions.

Paramètres

sort_field - String
Optionnel. Le champ qui servira de tri pour les résultats.

• name (défaut) - Le nom de l'utilisateur
• email - L'adresse email de l'utilisateur

sort_dir - String
Optionnel. Le sens du tri pour les résultats.

• asc (défaut)
• desc

start - Integer
Optionnel. L'index du premier résultat à retourner - par défaut 0, le premier utilisateur

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

Réponse

L'objet data contient le nombre total d'utilisateurs du compte (total, indépendant de la pagination) et la liste des utilisateurs de la page demandée.

uid - Integer
L'identifiant unique de l'utilisateur

email - String
L'adresse email de l'utilisateur, qui lui sert également d'identifiant de connexion

name - String
Le nom de l'utilisateur

locale - String
La langue de l'interface pour cet utilisateur : fr, en, it ou es. Peut être null si l'utilisateur n'a jamais choisi de langue.

permissions - Object
Les droits de l'utilisateur sur le compte. Chaque droit est un booléen.

• campaign - Créer et envoyer des campagnes
• contacts - Gérer les listes et les contacts
• reports - Consulter les statistiques et les rapports
• transactional - Accéder aux emails transactionnels
• manage_account - Administrer le compte (facturation, utilisateurs, paramètres)

Exemple de réponse

{
    "ResponseType": "ok",
    "message": "Success",
    "QueryLeft": 0,
    "data": {
        "total": 3,
        "data": [
            {
                "uid": 1042,
                "email": "alice.martin@example.com",
                "name": "Alice Martin",
                "locale": "fr",
                "permissions": {
                    "campaign": true,
                    "contacts": true,
                    "reports": true,
                    "transactional": true,
                    "manage_account": true
                }
            },
            {
                "uid": 1189,
                "email": "bruno.leroy@example.com",
                "name": "Bruno Leroy",
                "locale": "fr",
                "permissions": {
                    "campaign": true,
                    "contacts": true,
                    "reports": true,
                    "transactional": false,
                    "manage_account": false
                }
            },
            {
                "uid": 1247,
                "email": "chiara.rossi@example.com",
                "name": "Chiara Rossi",
                "locale": "it",
                "permissions": {
                    "campaign": false,
                    "contacts": false,
                    "reports": true,
                    "transactional": false,
                    "manage_account": false
                }
            }
        ]
    }
}