Get specific people list info

Retrieve detailed information about a specific people list reachable from your API key: created via the API, with “Share to API” turned on, or a global list curated by Specter. Includes the ids of the people it contains. Lists shared only within your team are not accessible from the API.

GET /lists/people/{listId}

Get specific people list info

cURL

curl --request GET \
  --url https://app.tryspecter.com/api/v1/lists/people/{listId} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://app.tryspecter.com/api/v1/lists/people/{listId}"

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/people/{listId}', 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/people/{listId}",
  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/people/{listId}"

	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/people/{listId}")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.tryspecter.com/api/v1/lists/people/{listId}")

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

200

{
  "id": "b73c8bed-3b92-48f9-a879-40ee114dca03",
  "name": "Favourites",
  "created_at": "2024-11-14T10:36:12.625Z",
  "updated_at": "2024-11-14T10:36:12.625Z",
  "people": [
    {
      "person_id": "per_2f3c7fe468ec9fc2181bec8b",
      "created_at": "2025-01-02T17:29:46.688Z"
    }
  ]
}

{
  "errorCode": "INVALID_LIST_UUID",
  "message": "List id must be a valid UUID."
}

{
  "errorCode": "API_KEY_MISSING",
  "message": "No API Key was presented on the header X-API-KEY"
}

{
  "errorCode": "<string>",
  "message": "<string>"
}

{
  "errorCode": "<string>",
  "message": "<string>"
}

Authorizations

X-API-Key · string · header · required

Path Parameters

listId · string<uuid> · required

The ID of the list being requested.

Response

200

application/json

The list including people ids

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"

people · object[]

The people included in this list

Show child attributes