Récupérer les entreprises de votre liste
Les entreprises dans vos listes peuvent être récupérées page par page avec page et size.
Vous pouvez également les trier avec sortKey et sortOrder.
Pour filtrer vos entreprises, vous pouvez utiliser le paramètre query.
Inscrivez-vous pour accéder à toutes les fonctionnalités de notre API
Recevez vos 500 crédits gratuits et commencez à enrichir et rechercher des entreprises.
Aucune carte de crédit requise
La page à récupérer (par défaut 1).
/lists/:listId/companies?page=1
Le nombre d'entreprises à récupérer (entre 1 et 100). Par défaut 10.
/lists/:listId/companies?size=10
La requête pour filtrer les entreprises dans votre liste.
Assurez-vous que ce paramètre soir stringifié et encodé.
Un array de plusieurs champs combinés pour trier les résultats.
…/lists/:listId/companies?sortFields=%5B%7B%22key%22%3A%22meta.score%22%2C%22order%22%3A%22desc%22%7D%5D
Assurez-vous que ce paramètre soir stringifié et encodé.
Le champ pour trier les résultats.
…/lists/:listId/companies?sortKey=meta.score
Valeurs possibles
L'ordre pour trier les résultats.
…/lists/:listId/companies?sortOrder=asc
Valeurs possibles
Les informations sur les métas.
import createClient from '@thecompaniesapi/sdk'
const tca = createClient({ apiToken: 'YOUR_API_TOKEN' })
const response = await tca.fetchCompaniesInList({
listId: 1234
})
const companies = response.data.companies // Companies that match the list
const meta = response.data.meta // Meta information