Passer au contenu principal
Toutes les requêtes de type liste peuvent être paginées et filtrées en utilisant le même format de requête. Pour plus de commodité, nous avons veillé à ce que tous les endpoints de type liste retournent des données avec la même structure.

​
Pagination

Nous utilisons 2 paramètres pour la pagination :
  • take est le nombre d’éléments que l’API va retourner, par défaut 50, max 100
  • skip est le nombre d’éléments que l’API va ignorer, par défaut 0
Donc si vous voulez obtenir les 50 premiers éléments d’une liste, vous n’avez besoin d’aucun paramètre. Si vous avez besoin des éléments du 350e au 425e, vous utiliserez take=75 et skip=350. Voici un exemple avec la liste des clients : 
curl --request GET \
  --url 'https://api.hyperline.co/v1/customers?take=10&skip=10' \
  --header 'Authorization: Bearer <token>'
L’API renverra toujours une charge utile de forme similaire contenant :
  • data les éléments que vous avez demandés
  • meta les informations contextuelles (nombre total d’éléments, nombre sélectionné, etc.)
Par exemple pour les clients : 
{
  "meta": {
    "total": 2,
    "taken": 2,
    "skipped": 0
  },
  "data": [
    {
      "id": "cus_3fhwCWcL0Rx5MQ"
      // other properties
    },
    {
      "id": "cus_9huL9ahn7KQqHo"
      // other properties
    }
  ]
}

​
Tri

Certains endpoints de liste prennent en charge le tri des résultats à l’aide des paramètres de requête sort et order :
  • sort spécifie le champ sur lequel trier (par exemple, created_at, emitted_at)
  • order spécifie le sens du tri : asc (croissant) ou desc (décroissant)
Par exemple : 
curl --request GET \
  --url 'https://api.hyperline.co/v1/invoices?sort=emitted_at&order=desc' \
  --header 'Authorization: Bearer <token>'
Tous les endpoints de liste ne prennent pas en charge le tri. Reportez-vous à la documentation de chaque endpoint pour voir quels champs de tri sont disponibles.

​
Filtrage

Notre API offre de nombreuses possibilités de filtrage afin que vous puissiez toujours trouver ce que vous cherchez. Les filtres sont passés en tant que paramètres de requête selon un schéma commun. fieldName__operator=value Par exemple :
  • GET /v1/customers?name__contains=instagram renverra tous les clients dont le nom contient instagram
  • GET /v1/customers?id__in=123,456,789 renverra les clients dont l’ID est égal à 123, 456 ou 789

​
Liste des opérateurs disponibles

  • equals (ou simplement <field>=xxx)
  • not
  • lt
  • lte
  • gt
  • gte
  • contains
  • startsWith
  • endWith
  • in
  • notIn
  • isNull
  • isNotNull
Les opérateurs numériques peuvent être appliqués aux nombres ou aux dates.
Tous les champs ne peuvent pas être filtrés ; veuillez consulter chaque modèle dans la référence API pour voir lesquels sont disponibles.