Skip to main content

Endpoint & Authentification

En-têtes (Headers) :
  • Authorization: Bearer [VOTRE_JETON_D_API]
  • X-Arquos-Agency: [IDENTIFIANT_D_AGENCE] (facultatif, voir Agence)

Paramètres de la requête

string
Ce qu’on cherche (nom, adresse).
integer
Combien de lignes, 50 par défaut, 200 au plus.
integer
La page, à partir de 1.
string
L’identifiant de l’agence où agir. Absent : l’agence par défaut du compte. Une agence hors de sa portée est refusée (403).

Réponse (200)

integer
Le nombre de lignes qui répondent, toutes pages confondues.
integer
La page rendue, à partir de 1.
integer
Le nombre de lignes par page (50 par défaut, 200 au plus).
object[]
Les lignes de la page.

Les erreurs

Le corps d’une erreur porte error, sa raison en français. Voir Les erreurs.