Skip to main content
GET
/
lists
/
companies
Get all company lists
curl --request GET \
  --url https://app.tryspecter.com/api/v1/lists/companies \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://app.tryspecter.com/api/v1/lists/companies"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://app.tryspecter.com/api/v1/lists/companies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://app.tryspecter.com/api/v1/lists/companies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://app.tryspecter.com/api/v1/lists/companies"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-Key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://app.tryspecter.com/api/v1/lists/companies")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.tryspecter.com/api/v1/lists/companies")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
[
  {
    "id": "b73c8bed-3b92-48f9-a879-40ee114dca03",
    "name": "Favourites",
    "created_at": "2024-11-14T10:36:12.625Z",
    "updated_at": "2024-11-14T10:36:12.625Z",
    "is_global": false,
    "company_count": 10,
    "shared_with": [
      "user_2PFJ2V8IR837k6TPguVCIFhNsWA"
    ]
  }
]
{
"errorCode": "API_KEY_MISSING",
"message": "No API Key was presented on the header X-API-KEY"
}
{
"errorCode": "NOT_PERMITTED",
"message": "You do not have permission to access this resource."
}
{
"errorCode": "<string>",
"message": "<string>"
}

Authorizations

X-API-Key
string
header
required

Response

The companies lists

id
string

List Id

Example:

"b73c8bed-3b92-48f9-a879-40ee114dca03"

name
string

Name of the list

Example:

"Favourites"

created_at
string<date-time>

Date list was created

Example:

"2024-11-14T10:36:12.625Z"

updated_at
string<date-time>

Date the list was last updated

Example:

"2024-11-14T10:36:12.625Z"

is_global
boolean

This flags lists recommended by Specter for all users

Example:

false

company_count
number

The number of companies in this list

Example:

10

shared_with
string[]

The user ids of the users this search is shared with

User Id