Récupérer vos listes
Gérez vos listes d'entreprises et leurs détails.
GET
https://api.thecompaniesapi.com/v2/lists
Gratuit
Cette fonctionnalité vous permet de récupérer vos listes qui appartiennent à votre compte.
Pour récupérer les entreprises dans une liste spécifique, allez à
.Inscrivez-vous pour accéder à toutes les fonctionnalités
Recevez votre jeton d'API et commencez à implémenter l'API dans votre produit avec 500 crédits gratuits.
Aucune carte de crédit requise
Paramètres de requête
pagenumber (optionnel)
La page à récupérer (par défaut: 1).
/lists?page=1
sizenumber (optionnel)
Le nombre de listes à récupérer (entre 1 et 100). Par défaut à 10.
/lists?size=10
Schéma de réponse
listsarray
Les listes qui appartiennent à votre équipe.
metaobject
Les informations sur les métas.
Réponse de l'API
{lists :[{analytics :{…},createdAt : "2022-04-01T13:07:14.000+00:00" ,dynamic :false,id :4246,imported :false,integrations :[…],name : "US Companies using Node.js" ,processActive :false,processInitialized :true,processingAt : "2022-04-01T13:07:15.000+00:00" ,query :[…],},{analytics :{…},createdAt : "2022-02-22T07:23:52.000+00:00" ,dynamic :false,id :3837,imported :false,integrations :[ ],name : "Edtech Companies" ,processActive :false,processInitialized :true,processingAt : "2022-02-22T07:23:53.000+00:00" ,query :[…],},],meta :{currentPage :1,firstPage :1,lastPage :1,perPage :10,total :4,},}
Exemples de code
Sélectionnez votre langage favori :
import createClient from '@thecompaniesapi/sdk'
const tca = createClient({ apiToken: 'YOUR_API_TOKEN' })
const response = await tca.fetchLists()
const lists = response.data.lists // Lists that match the query
const meta = response.data.meta // Meta information