/api/lists/getall

Version and Endpoint

Request

This endpoint requires authentication headers. See Authentication documentation.

Adding companies to a list

Lists are created and filled in the web portal, not through the API. Use the Import Companies tab on the Search page (you need to be logged in) to upload a plain .csv file with one company registration number per line and give the list a name.

• A list can hold up to 2,000 companies, so a single import can contain up to 2,000 company numbers. Each import needs a new list name (up to 200 characters), because a list name that already exists is rejected.
• Company details and financial figures in a list are refreshed from the latest data every time the list is loaded, in the portal or through the API.
• Companies of every status (active, dissolved, in liquidation and so on) can be imported. The Status filter on the search page does not apply to imports.
• Registration numbers of 6 or 7 digits are padded with leading zeros to 8 characters.
• Companies with no filed financial data are still added to the list, with their basic details (name, status, address and so on) and empty financial fields. Numbers that cannot be matched to a company are shown as "Not found" in the import results.
• Importing does not use credits. Loading a list in the portal costs 1 credit per company the first time you view it, and reloading it is free for the next month. Retrieving a list through the API (/api/lists/getlistdata) works like /Financials: it returns the full financial statements and uses 1 credit for each company that has financial data, on every call. See the getlistdata page for details.

To pull financials for a set of company numbers without creating a list, call /api/financials for each company number.

Tracked Companies Migration

All 'Tracked' companies from the original beta version have been automatically migrated to a new list called 'Tracked Companies' and will be available at this endpoint. The tracked companies endpoint is deprecated but still available and users are strongly encouraged to use lists instead.

Method Type

Authentication

Request Parameters

HTTP Response codes

Response JSON Sample

{
    "status": "Ok",
    "lists": [
        "High Value Leads",
        "Investment Targets",
        "Watchlist Companies"
    ],
    "errorMessage": null
}

Response Properties