Lire un client

curl --request GET \
--url https://api.arquos.eu/api/v2/clients/ID_DE_L_OBJET \
--header 'Authorization: Bearer arq_agent_VOTRE_JETON'

{
"type": "client",
"id": "3f1c2b9e-8a4d-4c1e-9b7a-2d5e6f708192",
"link": "/equipment/3f1c…",
"url": "https://app.arquos.eu/url",
"fields": {
  "name": "texte",
  "status": "texte",
  "clientNumber": "texte",
  "address": "texte",
  "address2": "texte",
  "phone": "texte",
  "email": "texte",
  "siren": "texte",
  "siret": "texte"
}
}

curl --request GET \
--url https://api.arquos.eu/api/v2/clients/ID_DE_L_OBJET \
--header 'Authorization: Bearer arq_agent_VOTRE_JETON'

{
"type": "client",
"id": "3f1c2b9e-8a4d-4c1e-9b7a-2d5e6f708192",
"link": "/equipment/3f1c…",
"url": "https://app.arquos.eu/url",
"fields": {
  "name": "texte",
  "status": "texte",
  "clientNumber": "texte",
  "address": "texte",
  "address2": "texte",
  "phone": "texte",
  "email": "texte",
  "siren": "texte",
  "siret": "texte"
}
}

Endpoint & Authentification

Méthode	URL
`GET`	`https://api.arquos.eu/api/v2/clients/{id}`

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

required

L’identifiant de l’objet.

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`)

string

Le type de l’objet, au singulier.

string

L’identifiant Arquos.

string

Le chemin de la fiche dans Arquos.

string

L’adresse complète de la fiche, à ouvrir dans un navigateur.

object

Les informations de la fiche, par identifiant d’attribut. Toutes sont présentes ; une information non renseignée vaut null.

Show Ses champs

string

Nom. Un texte. Peut valoir null.

string

Statut. Valeurs possibles : client (Client), prospect (Prospect). Peut valoir null.

string

N° de client. Un texte. Peut valoir null.

string

Adresse. Un texte. Peut valoir null.

string

Complément d’adresse. Un texte. Peut valoir null.

string

Téléphone. Un texte. Peut valoir null.

string

Email. Une adresse email. Peut valoir null.

string

SIREN. Un texte. Peut valoir null.

string

SIRET. Un texte. Peut valoir null.

Les erreurs

Code	Quand
`400`	Requête mal formée ou champ obligatoire manquant.
`401`	Jeton absent, inconnu ou révoqué.
`403`	Agence hors de votre portée.
`404`	Objet introuvable dans vos agences.
`429`	Trop d’appels : réessayez après le délai de l’en-tête Retry-After.

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

curl --request GET \
--url https://api.arquos.eu/api/v2/clients/ID_DE_L_OBJET \
--header 'Authorization: Bearer arq_agent_VOTRE_JETON'

{
"type": "client",
"id": "3f1c2b9e-8a4d-4c1e-9b7a-2d5e6f708192",
"link": "/equipment/3f1c…",
"url": "https://app.arquos.eu/url",
"fields": {
  "name": "texte",
  "status": "texte",
  "clientNumber": "texte",
  "address": "texte",
  "address2": "texte",
  "phone": "texte",
  "email": "texte",
  "siren": "texte",
  "siret": "texte"
}
}

Démarrer

API REST

Centres d'appels

Agents IA

Référence · Compte

Référence · Recherche

Référence · Équipements

Référence · Relevés

Référence · Contrats

Référence · Import

Référence · Webhooks

Référence · Référentiels

Référence · Affaires

Référence · Appels

Référence · Visites

Référence · Techniciens

Référence · Pièces

Référence · Devis

Référence · Notes

Référence · Écarts et réserves

Référence · Factures

Référence · Clients

Référence · Immeubles

Référence · Contacts

Référence · Secteurs

Référence · Campagnes

Référence · Contrôles techniques

Référence · Sollicitations

Endpoint & Authentification

Paramètres de la requête

Réponse (`200`)

Les erreurs

​Endpoint & Authentification

​Paramètres de la requête

​Réponse (200)

​Les erreurs

Endpoint & Authentification

Paramètres de la requête

Réponse (`200`)

Les erreurs