Aller au contenu
Livstick Développeurs
v3 Demander un accès

Groupes de codes

Une seule opération : lister les groupes de codes de la plateforme authentifiée.

v3 URL de base https://client-api.v5.livstick.com/api/v3

Qu’est-ce qu’un groupe de codes ?

Un groupe de codes est un lot : des conteneurs créés à l’avance, avant que l’on sache qui utilisera chacun d’eux — le mécanisme des parcours fondés sur un support physique pré-imprimé. Consultez la page de concept pour savoir comment un groupe de codes est défini à la création d’un conteneur. À noter : GET /messages accepte un paramètre de requête codeGroupId pour restreindre sa liste à un groupe de codes.

Opérations

Méthode GET /code-groups

Scope code_groups:read

Liste, avec pagination, les groupes de codes de la plateforme authentifiée.

Paramètres

Nom Emplacement Type Requis Description
limit Paramètre de requête integer Facultatif Nombre maximal d’éléments à renvoyer. 50 par défaut, 200 au maximum.
skip Paramètre de requête integer Facultatif Nombre d’éléments à ignorer (décalage de pagination). 0 par défaut.
order Paramètre de requête string Facultatif Champ de tri, préfixé par - pour un ordre décroissant. -createdAt par défaut.

Réponse

json 200 
{
  "items": [
    {
      "objectId": "grp456",
      "name": "Spring Campaign",
      "publicId": "spring-launch",
      "status": 0,
      "createdAt": "2025-01-10T08:00:00.000Z"
    }
  ],
  "total": 5,
  "limit": 50,
  "skip": 0
}