Create a new company list

What it does

Creates a new list of companies that is shared with the API and returns the new list’s id.

Why you’d use it

Programmatically build and maintain sourcing/diligence shortlists (e.g., thesis- or region-based cohorts such as “European B2B DeepTech”)

Key behaviors

• Add companies at creation by passing their company IDs, or add them later via the PATCH endpoint for that list id.
• The list owner will be the first team admin added to the account.
• You cannot create two lists with the same name. List names must be unique; if a name already exists, rename the existing list or choose a new name.

POST /lists/companies

Create a new company list

cURL

curl --request POST \
  --url https://app.tryspecter.com/api/v1/lists/companies \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "My list",
  "company_ids": [
    "5e3a7f2b0aa7a3270a55f2a7"
  ],
  "is_public": true
}
'

import requests

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

payload = {
    "name": "My list",
    "company_ids": ["5e3a7f2b0aa7a3270a55f2a7"],
    "is_public": True
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'My list', company_ids: ['5e3a7f2b0aa7a3270a55f2a7'], is_public: true})
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'My list',
    'company_ids' => [
        '5e3a7f2b0aa7a3270a55f2a7'
    ],
    'is_public' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"My list\",\n  \"company_ids\": [\n    \"5e3a7f2b0aa7a3270a55f2a7\"\n  ],\n  \"is_public\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.tryspecter.com/api/v1/lists/companies")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My list\",\n  \"company_ids\": [\n    \"5e3a7f2b0aa7a3270a55f2a7\"\n  ],\n  \"is_public\": true\n}")
  .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::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My list\",\n  \"company_ids\": [\n    \"5e3a7f2b0aa7a3270a55f2a7\"\n  ],\n  \"is_public\": true\n}"

response = http.request(request)
puts response.read_body

201

"a1d2434c-e089-480a-8a27-9909d2f558b4"

{
  "errorCode": "NO_TEAM_ADMIN",
  "message": "Cannot process request without a team admin, please request a team admin is added to your account.\n"
}

{
  "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

Body

application/json

Name and list of companies to add to the new list

name · string · required

Name of the list to create

Example:

"My list"

company_ids · string[]

ID of company being added

is_public · boolean

Whether the list is shared with other users in the team

Example:

true

Response

201

application/json

The ID of the list that was created

ID of the list

Example:

"a1d2434c-e089-480a-8a27-9909d2f558b4"