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 (branchList), tranche d'effectif (workforceSlice) et données associées (regCompanyDataList : sites web, réseaux sociaux, etc.).

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
linkedin	String|String[]	conditionnel	Identifiant(s) de profil LinkedIn

TIP

Au moins un paramètre est obligatoire.

Réponses

200 — OK

{
    "success": true,
    "parameters": {
        "idAccount": "string|null",
        "idCompany": "int[]|null",
        "siren": "string[]|null",
        "siret": "string[]|null",
        "tvaNumber": "string[]|null",
        "domain": "string[]|null",
        "linkedin": "string[]|null"
    },
    "companyList": [
        {
            "idCompany": "int",
            "siren": "string",
            "name": "string",
            "nameNormalized": "string|null",
            "commercialName": "string|null",
            "commercialNameNormalized": "string|null",
            "legalFormCode": "int|null",
            "tvaNumber": "string|null",
            "creationDate": "date",
            "endDate": "date|null",
            "lastEventDate": "date",
            "objetSocial": "string|null",
            "capitalSocial": "float|null",
            "greffe": "string|null",
            "dateCloture": "string|null",
            "prochaineDateCloture": "string|null",
            "isActive": "bool",
            "isEditor": "bool",
            "isIntegrator": "bool",
            "branchSiege": "int",
            "createdRow": "datetime",
            "modifiedRow": "datetime",
            "companyNonDiffusible": "bool",
            "procedureCollectiveEnCours": "date|null",
            "pappersLastSyncDate": "date|null",
            "idWorkforceSlice": "int|null",
            "branchList": [
                {
                    "idBranch": "int",
                    "identifiedNumber": "string",
                    "idNaf": "int|null",
                    "adressLine1": "string|null",
                    "adressLine2": "string|null",
                    "adressLine3": "string|null",
                    "adressLine4": "string|null",
                    "adressLine5": "string|null",
                    "adressLine6": "string|null",
                    "adressLine7": "string|null",
                    "adressPostalCode": "string|null",
                    "adressCity": "string|null",
                    "adressState": "int|null",
                    "adressCounty": "int|null",
                    "creationDate": "date",
                    "endDate": "date|null",
                    "lastEventDate": "date",
                    "enseigne": "string|null",
                    "commercialName": "string|null",
                    "isActive": "bool",
                    "idCompany": "int",
                    "pappersLastSyncDate": "date|null",
                    "latitude": "float|null",
                    "longitude": "float|null",
                    "createdRow": "datetime",
                    "modifiedRow": "datetime",
                    "departement": {
                        "idDepartement": "int|null",
                        "departementName": "string|null",
                        "idRegion": "int|null"
                    },
                    "region": {
                        "idRegion": "int|null",
                        "regionName": "string|null"
                    },
                    "nafCode": {
                        "idNaf": "int",
                        "code": "string",
                        "title": "string",
                        "section": "string|null",
                        "division": "string|null",
                        "groupe": "string|null",
                        "classe": "string|null"
                    }
                }
            ],
            "financials": null,
            "legalForm": {
                "code": "int",
                "title": "string",
                "level": "int|null"
            },
            "workforceSlice": {
                "idWorkforceSlice": "int",
                "title": "string"
            },
            "regCompanyDataList": [
                {
                    "idCompanyData": "int",
                    "siren": "string|null",
                    "idCompany": "int",
                    "value": "string",
                    "idCompanyDataType": "int",
                    "subId": "string|null",
                    "subTechId": "string|null",
                    "webScheme": "string|null",
                    "created": "datetime",
                    "modified": "datetime",
                    "isDeleted": "bool",
                    "isValid": "bool",
                    "skipTrigger": "bool|null",
                    "sourceList": [
                        {
                            "idCompanyData": "int",
                            "idCompanyDataSource": "int",
                            "subjectId": "string|null",
                            "subjectName": "string|null",
                            "created": "datetime",
                            "modified": "datetime"
                        }
                    ],
                    "otherData": "object|null"
                }
            ],
            "conventionCollectiveList": []
        }
    ]
}

Notes :

• branchList contient les établissements de la société. identifiedNumber est le SIRET de l'établissement ; branchSiege (au niveau société) référence l'idBranch du siège.
• dateCloture est au format MM-DD ; prochaineDateCloture au format YYYY-MM-DD.
• regCompanyDataList regroupe les données associées (site web, page LinkedIn…) typées par idCompanyDataType, avec leurs sources (sourceList). Pour les données LinkedIn, otherData contient { about, image, logo, slogan }.
• financials et conventionCollectiveList ne sont pas alimentés sur cet endpoint (toujours null / []).

400 — Bad Request

{
    "success": false,
    "message": "Paramètre idCompany, siren, siret, tvaNumber, domain ou linkedin nécessaire",
    "parameters": {}
}

401 — Unauthorized

{
    "success": false,
    "code": "401",
    "message": "Clé API invalide"
}

403 — Forbidden

{
    "success": false,
    "code": 403,
    "message": "L'abonnement n'a pas accès à ces données",
    "parameters": {}
}