Sociétés
Permet de récupérer les informations sur les sociétés.
Récupérer les sociétés
GET/v1/companyRetourne les informations détaillées d'une ou plusieurs sociétés (données corporate, établissements, effectifs, données associées).
Headers
| Nom | Type | Requis | Description |
|---|---|---|---|
| x-access-token | String | oui | Clé API |
Paramètres query
| Nom | Type | Requis | Description |
|---|---|---|---|
| idCompany | int|int[] | conditionnel | Identifiant(s) de société |
| siren | String|String[] | conditionnel | Numéro(s) SIREN |
| siret | String|String[] | conditionnel | Numéro(s) SIRET |
| tvaNumber | String|String[] | conditionnel | Numéro(s) de TVA intracommunautaire |
| domain | String|String[] | conditionnel | Nom(s) de domaine du site web |
| String|String[] | conditionnel | Identifiant(s) de profil LinkedIn |
TIP
Au moins un paramètre est obligatoire.
Réponses
200 — OK
json
{
"success": true,
"code": "200",
"message": "OK",
"parameters": {
"idCompany": "int|null",
"siren": "string|null"
},
"result": {
"companyList": [
{
"idCompany": "int",
"companyName": "string",
"siren": "string",
"siret": "string",
"tvaNumber": "string",
"domain": "string",
"linkedin": "string",
"address": "string",
"postalCode": "string",
"city": "string",
"country": "string",
"workforce": "int",
"revenue": "float",
"nafCode": "string",
"nafLabel": "string",
"legalForm": "string",
"created": "datetime",
"modified": "datetime"
}
]
}
}400 — Bad Request
json
{
"success": false,
"code": "400",
"message": "Au moins un paramètre est requis"
}401 — Unauthorized
json
{
"success": false,
"code": "401",
"message": "Clé API invalide"
}