/api/lists/getall

This API endpoint returns all of your created lists. Currently, companies can be added to a list using the web portal through a CSV file bulk import or by running a search and saving results as a list.

Lists Version 2

Version and Endpoint

Only available in API version 2

Request

GET https://convert-ixbrl.co.uk/api/lists/getall?apiversion=2

This endpoint requires authentication headers. See Authentication documentation.

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

HTTP GET

Authentication

This endpoint requires the authentication header to be supplied. See the authentication section.

Request Parameters

Name	Type	Optional	Description
apiVersion	string	No	API Version (currently 2)

HTTP Response codes

Status Code	Description
`200`	Successful requests with results
`204`	Successful requests with no results
`400`	Authorisation error for when the secret key header is missing or is invalid

Response JSON Sample

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

Response Properties

Name	Type	Nullable	Description
status	string	no	Contains Ok if the request was successful, Error if there was an error.
errorMessage	string	yes	If the request was unsuccessful, this would contain a description of the error where available
lists[]	array	yes	Contains the names of lists that have been created. Each item is of type string. Data for each list can be retrieved using the /GetListData endpoint.