Company & Employee Enrichment API
Create a List of Companies or Employees with our Enrichment API
Create a list of companies or employeesFree
Free
This endpoint allows you to create a list of companies or employees.
Query parameters
dynamicoptional
Whether the list is dynamic or not. If set to true, the list will be updated automatically when new companies or employees are added to the database.
Possible values
namerequired
The name of the list.
typerequired
The type of list to create.
Possible values
Response
list. analyticsobject
The analytics of the list.
list. companyListobject
The associated company list when there is one.
list. createdAtdate
When the list was created.
list. dynamicboolean
Whether the list is dynamic or static.
list. idnumber
The id of the list.
list. importedboolean
Whether the list has been imported.
list. integrationsarray
The integrations associated with the list.
list. invisibleboolean
Whether the list is invisible (for internal use).
list. namestring
The name of the list
list. processActiveboolean
The process active status of the list (for internal use).
list. processInitializedboolean
The process initialized flag (for internal use).
list. processingAtdate
When the list is being processed.
list. queryarray
The query used to generate the list.
list. typestring
The type of the list.
Possible values
Endpoint
POST
https://api.thecompaniesapi.com/v1/lists
API response
{analytics :{ … },companyList : null ,createdAt : "2022-04-01T13:07:14.000+00:00" ,dynamic :false,id :4246,imported :false,integrations :[ ] ,invisible :false,name : "French NodeJS Companies" ,processActive :false,processInitialized :true,processingAt : "2022-04-01T13:07:15.000+00:00" ,query :[ ] ,type : "companies" ,}
Company & Employee Enrichment API