Search person name

Returns people whose name matches the query, each with a Specter person ID and a match confidence. Fetch a full profile with Get person info by ID.

Costs 1 credit per request, regardless of how many matches are returned.

Behaviour

• query is required and must be at least 3 characters.
• Returns at most 10 matches.
• Results are sorted by match_confidence (0–1) descending; only matches at or above 0.5 are returned.
• No matches returns an empty list.

GET /people/search

Search person name

cURL

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

import requests

url = "https://app.tryspecter.com/api/v1/people/search"

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/people/search', 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/people/search",
  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/people/search"

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

require 'uri'
require 'net/http'

url = URI("https://app.tryspecter.com/api/v1/people/search")

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": "per_7f8d9e2a1b3c4d5e6f7g8h9i0",
    "match_confidence": 0.98,
    "full_name": "Patrick Collison",
    "headline": "Co-founder and CEO at Stripe",
    "linkedin_url": "https://www.linkedin.com/in/patrickcollison",
    "profile_picture_url": "https://peopledb-public.s3.eu-west-2.amazonaws.com/assets/profile-pictures/per_7f8d9e2a1b3c4d5e6f7g8h9i0.jpg",
    "current_company_name": "Stripe"
  }
]

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

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

{
  "errorCode": "NOT_PERMITTED",
  "message": "You do not have permission to access this resource."
}

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

Authorizations

X-API-Key · string · header · required

Query Parameters

query · string · required

A name to search people by. Must be at least 3 characters.

Minimum string length: 3

Response

200

application/json

The list of matching people, sorted by descending match confidence.

id · string · required

The Specter person ID for this person, can be used in people endpoints.

Example:

"per_7f8d9e2a1b3c4d5e6f7g8h9i0"

match_confidence · number · required

How closely the person matched the query, from 0 to 1. Only matches with a confidence of at least 0.5 are returned.

Example:

0.98

full_name · string | null

The person's full name.

Example:

"Patrick Collison"

headline · string | null

The person's LinkedIn headline.

Example:

"Co-founder and CEO at Stripe"

linkedin_url · string | null

URL for the LinkedIn account.

Example:

"https://www.linkedin.com/in/patrickcollison"

profile_picture_url · string | null

A URL for a profile picture if there is one.

Example:

"https://peopledb-public.s3.eu-west-2.amazonaws.com/assets/profile-pictures/per_7f8d9e2a1b3c4d5e6f7g8h9i0.jpg"

current_company_name · string | null

The name of the person's current employer, when resolvable.

Example:

"Stripe"