Récupérer un contact
GET
https://api.lws.net/v1/
operationIdgetContact
Récupère des informations sur un contact à l'aide de son ID. Cet ID peut être obtenu via l'action '/contact/0/list' et est également fourni à la création du contact. Seuls les contacts gérés par l'utilisateur peuvent être récupérés.
Paramètres du chemin
-
contactinteger requis -
ID du contact recherché
Réponses
200
Contact récupéré avec succès
{
"code": 200,
"info": "Contact fetched",
"data": {
"company": "Ma Société",
"lastname": "Dupont",
"firstname": "Jean",
"address": "1 rue de la Paix",
"postal": "75000",
"city": "Paris",
"country": "France",
"phone": "0033612345678",
"email": "[email protected]",
"is_company": true,
"credit": 0
}
}
Champs de la réponse 14
-
codeinteger -
infostring -
dataobjectSchéma de réponse des informations de contact
-
companyanyNom de l'entreprise (optionnel)
-
lastnameanyNom de famille
-
firstnameanyPrénom
-
addressanyAdresse postale
-
postalstringCode postal
-
cityanyVille
-
countryanyPays
-
phoneanyNuméro de téléphone du contact au format international 00{code pays}{numéro}
-
emailanyAdresse email
-
is_companyanyIndique si le contact est pour une entreprise ou non
-
creditanySolde de crédit
400
Échec de la récupération du contact. Signifie généralement qu'un contact avec cet ID n'existe pas ou n'est pas valide.
{
"code": 400,
"info": "No contact provided"
}
Champs de la réponse 2
-
codeinteger -
infostring
401
Non autorisé - En-têtes d'authentification manquants
{
"code": 401,
"info": "Unauthorized access to the API. Please specify X-Auth-Pass and X-Auth-Login to proceed."
}
Champs de la réponse 2
-
codeinteger -
infostring
429
Limite de requêtes dépassée
{
"code": 429,
"info": "Rate limit exceeded. Please try again later."
}
Champs de la réponse 2
-
codeinteger -
infostring
500
Erreur interne du serveur. Les détails de l'erreur seront fournis dans 'data'
{
"code": 500,
"info": "Internal Server Error",
"data": "Details on the error"
}
Champs de la réponse 3
-
codeinteger -
infostring -
datastring
502
Réponse invalide retournée. Signifie généralement que les données retournées n'étaient pas attendues.
{
"code": 502,
"info": "Invalid response from upstream server",
"data": {
"status": 500,
"error": "Internal Server Error"
}
}
Champs de la réponse 3
-
codeinteger -
infostring -
dataany[]