Beam background
Documentation de l'API

Optimisez votre produit ou votre sales machine avec notre API d'enrichissement pour les entreprises et les employés

Entreprises
6 endpoints
Employés
3 endpoints
Industries
1 endpoints
Professions
1 endpoints
Localisations
5 endpoints
Listes
4 endpoints

Documentation de l'API

The Companies API est organisée selon l'architecture REST. Nos routes acceptent des requêtes encodées au format form et retournent des réponses encodées au format JSON. Vous pouvez sauter d'une fonctionnalité à l'autre avec le menu de navigation à gauche. Des exemples avec des réponses réelles sont fournis sur le côté droit de la page.

Besoin d'aide ?

Envoyez nous un message dans la chatbox. Un développeur vous répondra dès que possible pour répondre à vos questions.

Pas un développeur ?

Nous pouvons vous aider à intégrer notre API. Envoyez-nous un message dans la chatbox.

URL de base
https://api.thecompaniesapi.com

Authentification

The Companies API utilise des jetons d'API pour authentifier les requêtes.

Vous pouvez gérer vos jetons d'API dans vos paramètres ou sur le côté droit de cette section.

Il y a deux façons d'authentifier vos requêtes HTTP vers l'API:

- En ajoutant un en-tête Autorization. L'en-tête Authorization est formaté comme suit : Authorization: Basic MY-API-TOKEN (remplacez MY-API-TOKEN par l'un des vôtres).

- En envoyant le jeton API en tant que paramètre GET. Comme ceci ?token=MY-API-TOKEN (principalement utilisé pour tester rapidement un endpoint).

Vos jetons d'API
Pour vous aider à tester tous nos endpoints en un clic, votre jeton d'API est inclus dans tous les endpoints ci-dessous lorsque vous les copiez.
Vos Tokens API
Créer un Token API
magic
Vous n'avez pas encore de token API
Créez un token API pour commencer à utiliser notre API.

Erreurs & Rate-Limiting

The Companies API utilise des codes de réponse HTTP conventionnels pour indiquer le succès ou l'échec d'une requête API. En général, les codes dans la plage 2xx indiquent un succès. Les codes dans la plage 4xx indiquent une erreur qui a échoué compte tenu des informations fournies (par exemple, un paramètre requis a été omis). Les codes dans la plage 5xx indiquent une erreur avec nos serveurs (ce sont des cas rares).

Certaines erreurs 4xx qui peuvent être gérées de manière programmable comprennent un code d'erreur qui explique brièvement ce qu'il s'est produit.

Objet d'erreur

error. code string
Pour certaines erreurs qui peuvent être gérées de manière programmable, un chiffre indiquant le code d'erreur rapporté. 403
error. message string
Un message lisible par un humain fournissant plus de détails sur l'erreur. Missing api token
error. type enum
Le type d'erreur retourné (voir la liste à votre droite). apiConnectionError
Valeurs possibles apiConnectionError apiError authenticationError invalidRequestError noCreditsRemaining rateLimitError
Résumé des codes de statut HTTP
200 - OK La requête a réussi.
400 - Bad Request La requête est refusée, souvent en raison de l'absence d'un paramètre requis.
401 - Unauthorized Aucun jeton API valide fourni.
402 - Request Failed Les paramètres étaient valides, mais la requête a échoué.
403 - Forbidden Le jeton API n'a pas la permission d'exécuter la requête.
404 - Not Found La ressource demandée n'existe pas.
409 - Conflict La requête est en conflit avec une autre requête (peut-être en raison de l'utilisation de la même clé idempotente).
429 - Too Many Requests Trop de requêtes ont frappé l'API trop rapidement. Nous vous recommandons une temporisation de vos requêtes.
500, 502, 503, 504 - Server Errors Quelque chose s'est mal passé de notre côté. Ces rares erreurs doivent être signalées, mais nous les enregistrons avec Sentry et les corrigeons dès qu'elles se produisent.
Résumé des types d'erreurs HTTP
apiConnectionError Échec de la connexion à The Companies API.
apiError Les erreurs API couvrent tout autre type de problème (par exemple, un problème temporaire avec les serveurs de The Companies API) et sont extrêmement rares.
authenticationError Échec de l'authentification dans la requête.
invalidRequestError Les erreurs de requête invalides se produisent lorsque votre requête a des paramètres invalides.
noCreditsRemaining Vous n'avez plus de crédits restants pour effectuer cette requête.
rateLimitError Trop de requêtes ont frappé l'API trop rapidement. Nous vous recommandons une temporisation de vos requêtes.

Webhooks

The Companies API utilise des webhooks pour vous notifier des changements ou lorsqu'une opération est terminée.

Vous pouvez gérer vos webhooks sur le côté droit de cette section ou dans vos paramètres.

Les webhooks sont utiles pour recevoir les résultats de nos algorithmes. Par exemple, lorsque une nouvelle entreprise que vous avez demandée a été scrappée ou quand nous avons trouvé un nouvel employé pour une de vos listes dynamiques.

Vos Webhooks
Créer un nouveau webhook
magic
Vous n'avez pas encore de webhook
Créez un webhook pour recevoir une notification pour les événements que vous souhaitez suivre.

Entreprises

Vous trouverez ci-dessous toutes nos fonctionnalités concernant notre base de données d'entreprises.

Vous pouvez rechercher des entreprises avec une condition spécifique ou par nom. Vous pouvez également récupérer le profil d'une entreprise en fournissant son nom de domaine ou l'une de ses URL de réseaux sociaux. Vous désirez également récupérer des entreprises similaires ou même les patterns d'e-mails qu'elles utilisent? Nous avons la solution.

Endpoints disponibles
GET https://api.thecompaniesapi.com/v1/companies
GET https://api.thecompaniesapi.com/v1/companies/by-name
GET https://api.thecompaniesapi.com/v1/companies/by-social
GET https://api.thecompaniesapi.com/v1/companies/similar
GET https://api.thecompaniesapi.com/v1/companies/:domain
GET https://api.thecompaniesapi.com/v1/companies/:domain/email-patterns

Rechercher des entreprises par nom
1 crédit

Récupérez un profil d'entreprise en fournissant le nom de l'entreprise. Vous pouvez utiliser ce endpoint si vous avez besoin de plus d'informations sur l'entreprise, mais soyez prudent. Deux entreprises peuvent avoir le même nom, par exemple, Bolt. C'est pourquoi cette fonctionnalité peut retourner plusieurs entreprises.

Requête

name Requis
Le nom de l'entreprise. …/companies/by-name?name=amazon
countries Optionnel
Les pays pour filtrer les entreprises. Vous pouvez fournir plusieurs pays séparés par une virgule. Par défaut à tous les pays. …/companies/by-name?countries=us,fr,de
Valeurs possibles ad ae af ag ai al am ao aq ar as at au aw ax az ba bb bd be Afficher plus
exactWordsMatch Optionnel
Si défini à true, le nom de l'entreprise doit correspondre aux mots recherchés. 'Bank of A' ne retournera pas Bank of America mais 'Bank of' et 'Bank of America' le feront. Par défaut à true. …/companies/by-name?exactWordsMatch=false
size Optionnel
Le nombre d'entreprises à retourner (entre 1 et 25). Par défaut à 1. …/companies/by-name?name=amazon&size=2

Réponse

companies array
The companies that match with the name.
Afficher les attributs
meta array
Les informations sur les métas.
Afficher les attributs
endpoint
GET https://api.thecompaniesapi.com/v1/companies/by-name
Réponse
Chargement de la réponse...

Enrichir une entreprise à partir d'un nom de domaine
1 crédit

Enrichissez une entreprise en nous envoyant son nom de domaine. Le nom de domaine est un meilleur identifiant que le nom de l'entreprise car il est unique et moins sujet aux fautes de frappe.

Requête

domain Requis
Le nom de domaine de l'entreprise. …/companies/gucci.com

Réponse

company. alexaRank number
Le classement Alexa de l'entreprise. 8
company. analyzedAt string
La dernière fois que l'entreprise a été analysée. 2021-12-22T15:49:15.000Z
company. businessType string
Le type d'activité de l'entreprise. public-company
Valeurs possibles educational-institution government-agency nonprofit partnership privately-held public-company self-employed sole-proprietorship
company. city object
La ville de l'entreprise.
Afficher les attributs
company. codeNaics string
Le code SCIAN de l'entreprise. 518210
company. codeSic string
Le code SIC de l'entreprise. 5961
company. companiesAcquisitions array
Les sociétés acquises.
Afficher les attributs
company. companiesSubsidiaries array
Les sociétés filiales.
Afficher les attributs
company. companiesSimilar array
Les sociétés similaires.
Afficher les attributs
company. companyParent object
La société mère.
Afficher les attributs
company. continent object
Le continent de l'entreprise.
Afficher les attributs
company. country object
Le pays de l'entreprise.
Afficher les attributs
company. county object
Le département de l'entreprise.
Afficher les attributs
company. description string
La description de l'entreprise. Amazon.com, Inc. is an American multinational technology company based in Seattle, Washington, which focuses on…
company. descriptionShort string
La description courte de l'entreprise en une ligne. Amazon.com, Inc. is an American multinational technology company based in Seattle.
company. domain string
Le domaine de l'entreprise. amazon.com
company. domainAlts string
Les domaines alternatifs de l'entreprise (redirection).
company. domainName string
Le nom de domaine de l'entreprise. amazon
company. domainTld string
Le domaine de premier niveau de l'entreprise. com
company. emailPatterns array
Les modèles d'e-mails de l'entreprise pour les employés.
Afficher les attributs
company. id number
L'identifiant de l'entreprise. 5130216
company. industries array
Les secteurs d'activité de l'entreprise. Internet, Fashion, Marketing…
company. industryMain string
Le principal secteur d'activité de l'entreprise (généralement de LinkedIn). Internet
company. logo string
URL du logo de l'entreprise. https://poweredwith.nyc3.cdn.digitaloceanspaces.com/images/domains/amazon.com.jpg
company. monthlyVisitors enum
Nombre total de visiteurs mensuels de l'entreprise. over-1b
Valeurs possibles under-10k 10k-50k 50k-100k 100k-500k 500k-1m 1m-10m 10m-50m 50m-100m 100m-500m 500m-1b over-1b
company. name string
Le nom de l'entreprise. Amazon
company. phoneNumber string
Le numéro de téléphone de l'entreprise. 00 1 206-922-0880
company. revenue enum
Le chiffre d'affaires de l'entreprise. over-1b
Valeurs possibles under-1m 1m-10m 10m-50m 50m-100m 100m-200m 200m-1b over-1b
company. socialNetworks object
Les réseaux sociaux de l'entreprise.
Afficher les attributs
company. state object
Région de l'entreprise.
Afficher les attributs
company. stockExchange string
La bourse de la société. NYSE
company. stockSymbol string
Le symbole boursier de la société. AMZN
company. technologies array
Les technologies utilisées par l'entreprise.
company. technologyCategories array
Les catégories de technologies utilisées par l'entreprise.
company. totalEmployees enum
Le nombre total d'employés de l'entreprise. over-10k
Valeurs possibles 1-10 10-50 50-200 200-500 500-1k 1k-5k 5k-10k over-10k
company. totalEmployeesExact number
Le nombre exact d'employés de l'entreprise. 3930
company. yearFounded number
L'année de fondation de l'entreprise. 1994
endpoint
GET https://api.thecompaniesapi.com/v1/companies/gucci.com
Réponse
Chargement de la réponse...

Trouver des entreprises similaires
0.25 crédit

Envoyez-nous un ou plusieurs noms de domaine et nous vous retournerons une liste d'entreprises similaires.

Requête

domains Requis
Une liste de domaines séparés par des virgules. …/companies/similar?domains[]=gucci.com&domains[]=wix.com
page Optionnel
La page à récupérer (par défaut à 1). …/companies/similar?domains[]=…&page=1
size Optionnel
Le nombre de sociétés similaires à retourner (entre 1 et 100). Par défaut à 10. …/companies/similar?domains[]=…&size=50

Réponse

companies array
Les sociétés similaires pour votre liste de domaines.
Afficher les attributs
meta array
Les informations sur les métas.
Afficher les attributs
endpoint
GET https://api.thecompaniesapi.com/v1/companies/similar?domains[]=gucci.com&page=1&size=10
Réponse
Chargement de la réponse...

Trouver les formats d'emails pour un nom de domaine
1 crédit

Envoyez-nous un nom de domaine et récupérez tous les formats d'emails qu'ils utilisent avec le pourcentage d'utilisation.

Requête

domain Requis
The company domain. …/companies/gucci.com/email-patterns

Réponse

patterns array
The email patterns used.
Afficher les attributs
endpoint
GET https://api.thecompaniesapi.com/v1/companies/gucci.com/email-patterns
Réponse
Chargement de la réponse...

Employés

Nous concevons des algorithmes pour identifier les employés en temps réel ou les enrichir lorsque vous avez besoin de leur adresse e-mail ou de leurs informations de profil. Vous trouverez toutes nos fonctionnalités ci-dessous.

Endpoints disponibles
GET https://api.thecompaniesapi.com/v1/employees
GET https://api.thecompaniesapi.com/v1/employees/emails/discover
GET https://api.thecompaniesapi.com/v1/employees/emails/enrich

Identifier des employés en temps réel
10 crédits

Rechercher des employés avec certains intitulés de poste au sein d'une entreprise. Le nom de domaine de l'entreprise est requis, mais les intitulés de poste ne le sont pas. Vous pouvez également utiliser des conditions auxquelles les employés doivent correspondre pour des requêtes plus compliquées (voir paramètre query).

Vous pouvez également envoyer l'identifiant d'une de vos listes pour enregistrer les employés. Si vous n'avez pas de liste, vous pouvez en créer une avec notre endpoint pour créer une liste.

Requête

countries Optionnel
Les codes de pays (séparés par des virgules) à rechercher. Si non défini, nous rechercherons tous les pays. …/employees?countries=us,fr,de
Seuls les pays avec plus d'un million d'habitants sont disponibles.
Valeurs possibles ae af al am ao ar at au az ba bd be bf bg bh bi bj bo br bw Afficher plus
domain Requis
Le nom de domaine de l'entreprise à rechercher (peut également être une URL car nous extrairons le domaine). …/employees?domain=gucci.com
findEmails Optionnel
Si défini sur true, nous essaierons de trouver l'email professionnel des employés. Cela ralentira le temps de réponse. …/employees?findEmails=true
Nous conseillons aux utilisateurs d'éviter d'utiliser ce paramètre car il peut rendre le temps de réponse très long. À la place, utilisez notre endpoint pour découvrir les emails des employés lorsque vous recevez les résultats (gratuitement).
Valeurs possibles true false
hideCompany Optionnel
Si défini sur true, nous n'ajouterons pas les informations de l'entreprise aux employés. Cela rendra la réponse plus légère. (par défaut: false) …/employees?hideCompany=true
Valeurs possibles true false
jobTitles Optionnel
Les intitulés de poste (séparés par des virgules) à rechercher. Si non défini, nous rechercherons tous les intitulés de poste. …/employees?jobTitles=ceo,cto,software%20developer
listId Optionnel
L'identifiant de la liste pour enregistrer les employés. …/employees?listId=102
page Optionnel
La page à récupérer (par défaut: 1). …/employees?page=1
Vous devez demander la première page avant de demander les suivantes. Comme les employés sont trouvés en temps réel, nous ne pouvons pas savoir combien de pages il y a.
query Optionnel
Une liste plus complexe de conditions auxquelles les employés doivent correspondre (si vous souhaitez quelque chose de plus précis que le paramètre jobTitles ou countries).
Assurez-vous que ce paramètre soir stringifié et encodé (par exemple: encodeURIComponent).
Professions
=
Marketing
Parcourir
Ajouter une condition
GET https://api.thecompaniesapi.com/v1/employees?query=%5B%7B%22attribute%22%3A%22jobTitles%22%2C%22operator%22%3A%22or%22%2C%22sign%22%3A%22equals%22%2C%22values%22%3A%5B%22marketing%22%5D%7D%5D&domain=gucci.com
size Optionnel
Le nombre d'employés à renvoyer (par défaut à 100, max à 100). …/employees?size=10

Réponse

countries array
Les codes de pays (séparés par des virgules) à rechercher. Si non défini, nous rechercherons tous les pays.
employees array
Les employés qui correspondent à vos conditions.
Afficher les attributs
list object
La liste dans laquelle les employés ont été enregistrés.
Afficher les attributs
meta array
Les informations sur les métas.
Afficher les attributs
jobTitles array
Les intitulés de poste (séparés par des virgules) à rechercher. Si non défini, nous rechercherons tous les intitulés de poste.
query array
Une liste plus complexe de conditions auxquelles les employés doivent correspondre (si vous souhaitez quelque chose de plus précis que le paramètre jobTitles ou countries).
Afficher les attributs
endpoint
GET https://api.thecompaniesapi.com/v1/employees
Réponse
Chargement de la réponse...

Découvrir l'email d'un employé
5 crédits

Utilisez nos algorithmes pour trouver et vérifier l'email d'un employé. Envoyez-nous le prénom, le nom de famille, le second prénom et/ou l'identifiant de l'employé, et nous ferons le reste.

Requête

domain Optionnel
Le domaine de l'entreprise …/emails/discover?domain=gucci.com
employeeId Optionnel
L'identifiant de l'employé …/emails/discover?employeId=123
Les crédits ne sont pas déduits avec ce paramètre.
firstName Optionnel
Le prénom de l'employé …/emails/discover?firstName=Jay
fullName Optionnel
Le nom complet de l'employé …/emails/discover?fullName=Jay%20Gatsby
warningForFullName
lastName Optionnel
Le nom de famille de l'employé …/emails/discover?lastName=Gatsby
middleName Optionnel
Le second prénom de l'employé …/emails/discover?middle=James

Réponse

email string
L'email découvert. [email protected]
emailDisposable boolean
Si l'email est jetable ou non. false
emailDomain string
Le domaine de l'email. gucci.com
emailFree boolean
Si l'email est gratuit ou non. false
emailPattern string
Le modèle de l'email. [F].[L]
emailStatus string
Le statut de l'email. valid
Valeurs possibles catch-all error guessed identified verified verified-already
emailUsername string
Le nom d'utilisateur de l'email. jay.gatsby
endpoint
GET https://api.thecompaniesapi.com/v1/employees/emails/discover
Réponse
Chargement de la réponse...

Enrichir un employé à partir de son email
1 crédit

Envoyez-nous un email professionnel, et nous l'enrichirons avec le profil de la société ainsi que des données sur l'employé (voir la liste ci-dessous).

Requête

email Requis
L'email à enrichir. …/employees/emails/[email protected]

Réponse

company object
Le profil de l'entreprise pour l'email.
Afficher les attributs
email string
L'email à enrichir. [email protected]
emailDisposable boolean
Si l'email est jetable ou non. false
emailFree boolean
Si l'email est gratuit ou non. false
endpoint
GET https://api.thecompaniesapi.com/v1/employees/emails/enrich
Réponse
Chargement de la réponse...

Industries

Recherchez des industries spécifiques et obtenez des informations telles que le nombre d'entreprises qu'elle contient.

Endpoints disponibles
GET https://api.thecompaniesapi.com/v1/industries

Professions

Vous trouverez toutes nos fonctionnalités concernant notre base de données de professions ci-dessous. Recherchez ou enrichissez des professions avec les départements et les niveaux de seniorité. Vous pouvez utiliser ces fonctionnalités pour apporter plus de contexte à vos clients dans votre CRM ou pour trouver des employés spécifiques avec nos algorithmes.

Endpoints disponibles
GET https://api.thecompaniesapi.com/v1/job-titles/enrich

Enrichir une profession à partir de son nom
Gratuit

Envoyez-nous une profession (par exemple, directeur général) et récupérez des informations supplémentaires telles que les départements et les niveaux de responsabilité. Nous supportons les langues suivantes: anglais, français et espagnol.

Requête

name Requis
Le nom de la profession. …/job-titles/enrich?name=chief%20marketing%20officer

Réponse

jobTitle. department string
Le service de la profession marketing
Valeurs possibles customer service design education engineering finance health human resources legal marketing media operations public relations real estate sales trades
jobTitle. departmentSecondary string
Département secondaire de la profession content marketing
Valeurs possibles accounting accounts brand marketing broadcasting business development compensation content marketing customer success data dental devops doctor editorial education administration electrical employee development events fitness graphic design information technology Afficher plus
jobTitle. name string
Le nom anglais de la profession
jobTitle. nameEs string
Le nom espagnol de la profession
jobTitle. nameFr string
Le nom français de la profession
jobTitle. seniorityLevel string
Le niveau d'ancienneté de la profession
Valeurs possibles owner partner cxo vp director manager senior entry training unpaid
endpoint
GET https://api.thecompaniesapi.com/v1/job-titles/enrich
Réponse
Chargement de la réponse...

Localisations

Les endpoints suivants vous permettent de rechercher toutes nos localisations: villes, départements, régions, pays et continents.

Endpoints disponibles
GET https://api.thecompaniesapi.com/v1/locations/cities
GET https://api.thecompaniesapi.com/v1/locations/counties
GET https://api.thecompaniesapi.com/v1/locations/states
GET https://api.thecompaniesapi.com/v1/locations/countries
GET https://api.thecompaniesapi.com/v1/locations/continents

Rechercher des villes
Gratuit

Recherchez nos villes pour filtrer les entreprises ou cibler des employés dans un lieu spécifique.

Requête

page Optionnel
La page à récupérer (par défaut 1). …/locations/cities?page=1
search Optionnel
Une recherche additionnelle appliquée au nom de la ville. …/locations/cities?search=new%20york
size Optionnel
Le nombre de villes à retourner (entre 1 et 20). Par défaut 10. …/locations/cities?size=20

Réponse

cities array
Les villes qui correspondent à vos conditions.
Afficher les attributs
meta array
Les informations sur les métas.
Afficher les attributs
endpoint
GET https://api.thecompaniesapi.com/v1/locations/cities
Réponse
Chargement de la réponse...

Rechercher des départements
Gratuit

Rechercher des départements pour filtrer les entreprises ou cibler des employés dans un lieu spécifique.

Requête

page Optionnel
La page à récupérer (par défaut 1). …/locations/counties?page=1
search Optionnel
Une requête de recherche supplémentaire appliquée au nom du département. …/locations/counties?search=newport
size Optionnel
Le nombre de départements à retourner (entre 1 et 20). Par défaut 10. …/locations/counties?size=20

Réponse

counties array
Les départements qui correspondent à vos critères.
Afficher les attributs
meta array
Les informations sur les métas.
Afficher les attributs
endpoint
GET https://api.thecompaniesapi.com/v1/locations/counties
Réponse
Chargement de la réponse...

Rechercher des états
Gratuit

Rechercher nos régions pour filtrer nos entreprises ou cibler les employés dans un lieu spécifique.

Requête

page Optionnel
La page à récupérer (par défaut 1). …/locations/states?page=1
search Optionnel
Une recherche additionnelle appliquée au nom de la région. …/locations/states?search=new%20york
size Optionnel
Le nombre d'états à retourner (entre 1 et 20). Par défaut 10. …/locations/states?size=20

Réponse

states array
Les états qui correspondent à vos critères.
Afficher les attributs
meta array
Les informations sur les métas.
Afficher les attributs
endpoint
GET https://api.thecompaniesapi.com/v1/locations/states
Réponse
Chargement de la réponse...

Rechercher des pays