Skip to content

Sociétés

Permet de récupérer les informations sur les sociétés.

Récupérer les sociétés

GET /v1/company

Retourne les informations détaillées d'une ou plusieurs sociétés (données corporate, établissements, effectifs, données associées).

Headers

NomTypeRequisDescription
x-access-tokenStringouiClé API

Paramètres query

NomTypeRequisDescription
idCompanyint|int[]conditionnelIdentifiant(s) de société
sirenString|String[]conditionnelNuméro(s) SIREN
siretString|String[]conditionnelNuméro(s) SIRET
tvaNumberString|String[]conditionnelNuméro(s) de TVA intracommunautaire
domainString|String[]conditionnelNom(s) de domaine du site web
linkedinString|String[]conditionnelIdentifiant(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"
}

Coefficy — API externe