Fetch your lists
Manage your lists of companies and their details.
GET
https://api.thecompaniesapi.com/v2/lists
Free
The following feature let you retrieve your lists that belongs to your account.
To retrieve the companies in a specific list, go to
.Signup to access all our API features
Get your 500 free credits and start enriching and searching companies.
No credit card required
Query parameters
pagenumber (optional)
The page to fetch (default: 1).
/lists?page=1
sizenumber (optional)
The number of lists to be returned (between 1 and 100). Default to 10.
/lists?size=10
Response schema
listsarray
The lists that belong to your team.
metaobject
The metas information.
API response
{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,},}
Code examples
Select your favorite language:
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