Compte

Lister les utilisateurs du compte

GET /v1/users
vpn_key Permission read_users Compte comme une lecture

Renvoie les utilisateurs du compte, c'est-à-dire les personnes qui se connectent à l'application : leur identifiant, le nom qu'elles se sont donné, leur profil et leur point de caisse principal. Permission requise : read_users.

L'adresse mail d'un utilisateur n'est jamais renvoyée, pas plus qu'aucune donnée de connexion. alias est souvent vide pour le titulaire du compte : utilisez titulaire pour le reconnaître.

Le profil indique le rôle de l'utilisateur. Le détail de ce qu'un profil autorise n'est pas encore disponible par l'API. Les utilisateurs archivés sont listés aussi, en fin de liste.

La liste est courte et renvoyée en une seule fois, sans paramètre.

Exemple d'appel

curl "https://api.wanapos.com/v1/users" \
  -H "Authorization: Bearer VOTRE_CLE"

Réponse en cas de succès (statut 200)

Les utilisateurs du compte.

Champ Type Description
data liste Utilisateurs du compte : d'abord ceux en service, puis les utilisateurs archivés.
data[].id entier Identifiant de l'utilisateur.
data[].alias texte Nom que l'utilisateur s'est donné dans l'application. Souvent vide pour le titulaire du compte.
data[].titulaire booléen true pour le titulaire du compte, la personne qui l'a créé. Il y en a un seul.
data[].id_profil entier Identifiant du profil de l'utilisateur.
data[].profil texte Nom du profil. Les trois profils d'origine s'appellent admin, responsable et vendeur.
data[].profil_personnalise booléen true si le profil a été créé par le commerçant, false pour l'un des trois profils d'origine.
data[].id_point_caisse_principal entier Identifiant du point de caisse sur lequel l'utilisateur travaille par défaut (voir GET /v1/shops).
data[].archived booléen true si l'utilisateur a été archivé : il ne peut plus se connecter, mais reste listé.
data[].date_creation texte Date de création de l'utilisateur.
meta objet
meta.request_id texte Identifiant de l'appel.
meta.count entier Nombre d'éléments renvoyés.
{
    "data": [
        {
            "id": 2137,
            "alias": "",
            "titulaire": true,
            "id_profil": 1,
            "profil": "admin",
            "profil_personnalise": false,
            "id_point_caisse_principal": 1,
            "archived": false,
            "date_creation": "2025-03-12T10:04:11+01:00"
        },
        {
            "id": 2201,
            "alias": "Camille",
            "titulaire": false,
            "id_profil": 3,
            "profil": "vendeur",
            "profil_personnalise": false,
            "id_point_caisse_principal": 1,
            "archived": false,
            "date_creation": "2025-06-02T09:30:00+02:00"
        }
    ],
    "meta": {
        "request_id": "3f9a1c0b7d2e4a61",
        "count": 2
    }
}

Erreurs possibles

  • 401 Clé absente, inconnue ou révoquée. Codes : missing_key, invalid_key.
  • 403 Appel refusé pour ce compte ou cette clé. Codes : api_not_activated, account_not_eligible, access_blocked, missing_scope.
  • 422 Un paramètre est absent, inconnu ou invalide. Code : invalid_parameter. Le champ field nomme le paramètre.
  • 429 Quota dépassé. Codes : rate_limited, daily_quota_exceeded, too_many_failed_attempts. L'en-tête Retry-After indique combien de secondes attendre.

Voir toutes les erreurs

Une question ? contact@wanapos.com