curl --request POST \
--url https://api.collective.work/{environment}/v1/sherlock/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"text": "Senior fullstack engineer with 5+ years of React and Node.js, based in Paris, fintech experience",
"contractTypes": [
"FREELANCER",
"FREELANCER_OPEN_TO_PERMANENT_CONTRACT"
],
"excludeWithoutCv": true,
"availableNow": true,
"workedInStartup": true,
"searchOnlyInMyTalentsATS": true
}
'import requests
url = "https://api.collective.work/{environment}/v1/sherlock/search"
payload = {
"text": "Senior fullstack engineer with 5+ years of React and Node.js, based in Paris, fintech experience",
"contractTypes": ["FREELANCER", "FREELANCER_OPEN_TO_PERMANENT_CONTRACT"],
"excludeWithoutCv": True,
"availableNow": True,
"workedInStartup": True,
"searchOnlyInMyTalentsATS": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
text: 'Senior fullstack engineer with 5+ years of React and Node.js, based in Paris, fintech experience',
contractTypes: ['FREELANCER', 'FREELANCER_OPEN_TO_PERMANENT_CONTRACT'],
excludeWithoutCv: true,
availableNow: true,
workedInStartup: true,
searchOnlyInMyTalentsATS: true
})
};
fetch('https://api.collective.work/{environment}/v1/sherlock/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://api.collective.work/{environment}/v1/sherlock/search",
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([
'text' => 'Senior fullstack engineer with 5+ years of React and Node.js, based in Paris, fintech experience',
'contractTypes' => [
'FREELANCER',
'FREELANCER_OPEN_TO_PERMANENT_CONTRACT'
],
'excludeWithoutCv' => true,
'availableNow' => true,
'workedInStartup' => true,
'searchOnlyInMyTalentsATS' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.collective.work/{environment}/v1/sherlock/search"
payload := strings.NewReader("{\n \"text\": \"Senior fullstack engineer with 5+ years of React and Node.js, based in Paris, fintech experience\",\n \"contractTypes\": [\n \"FREELANCER\",\n \"FREELANCER_OPEN_TO_PERMANENT_CONTRACT\"\n ],\n \"excludeWithoutCv\": true,\n \"availableNow\": true,\n \"workedInStartup\": true,\n \"searchOnlyInMyTalentsATS\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.collective.work/{environment}/v1/sherlock/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"Senior fullstack engineer with 5+ years of React and Node.js, based in Paris, fintech experience\",\n \"contractTypes\": [\n \"FREELANCER\",\n \"FREELANCER_OPEN_TO_PERMANENT_CONTRACT\"\n ],\n \"excludeWithoutCv\": true,\n \"availableNow\": true,\n \"workedInStartup\": true,\n \"searchOnlyInMyTalentsATS\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.collective.work/{environment}/v1/sherlock/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"text\": \"Senior fullstack engineer with 5+ years of React and Node.js, based in Paris, fintech experience\",\n \"contractTypes\": [\n \"FREELANCER\",\n \"FREELANCER_OPEN_TO_PERMANENT_CONTRACT\"\n ],\n \"excludeWithoutCv\": true,\n \"availableNow\": true,\n \"workedInStartup\": true,\n \"searchOnlyInMyTalentsATS\": true\n}"
response = http.request(request)
puts response.read_body{
"searchId": "cm71yqftr00000ck0bpz3hpg1",
"status": "ONGOING"
}{
"message": [
"<string>"
],
"statusCode": 400,
"error": "Bad Request"
}{
"message": [
"<string>"
],
"statusCode": 403,
"error": "Forbidden"
}{
"message": [
"Internal server error"
],
"statusCode": 500,
"error": "Internal Server Error"
}Launch Sherlock search
Launch an asynchronous talent search (“Sherlock”) from a free-text brief and optional filters. Returns immediately with a searchId and an ONGOING status — poll the search to retrieve ranked results once it reaches COMPLETED.
This is a paid feature that must be activated on your organisation (PRO plan). Searches are metered per organisation: a monthly cap on completed searches plus a limit on concurrent in-flight searches. Learn more.
curl --request POST \
--url https://api.collective.work/{environment}/v1/sherlock/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"text": "Senior fullstack engineer with 5+ years of React and Node.js, based in Paris, fintech experience",
"contractTypes": [
"FREELANCER",
"FREELANCER_OPEN_TO_PERMANENT_CONTRACT"
],
"excludeWithoutCv": true,
"availableNow": true,
"workedInStartup": true,
"searchOnlyInMyTalentsATS": true
}
'import requests
url = "https://api.collective.work/{environment}/v1/sherlock/search"
payload = {
"text": "Senior fullstack engineer with 5+ years of React and Node.js, based in Paris, fintech experience",
"contractTypes": ["FREELANCER", "FREELANCER_OPEN_TO_PERMANENT_CONTRACT"],
"excludeWithoutCv": True,
"availableNow": True,
"workedInStartup": True,
"searchOnlyInMyTalentsATS": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
text: 'Senior fullstack engineer with 5+ years of React and Node.js, based in Paris, fintech experience',
contractTypes: ['FREELANCER', 'FREELANCER_OPEN_TO_PERMANENT_CONTRACT'],
excludeWithoutCv: true,
availableNow: true,
workedInStartup: true,
searchOnlyInMyTalentsATS: true
})
};
fetch('https://api.collective.work/{environment}/v1/sherlock/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://api.collective.work/{environment}/v1/sherlock/search",
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([
'text' => 'Senior fullstack engineer with 5+ years of React and Node.js, based in Paris, fintech experience',
'contractTypes' => [
'FREELANCER',
'FREELANCER_OPEN_TO_PERMANENT_CONTRACT'
],
'excludeWithoutCv' => true,
'availableNow' => true,
'workedInStartup' => true,
'searchOnlyInMyTalentsATS' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.collective.work/{environment}/v1/sherlock/search"
payload := strings.NewReader("{\n \"text\": \"Senior fullstack engineer with 5+ years of React and Node.js, based in Paris, fintech experience\",\n \"contractTypes\": [\n \"FREELANCER\",\n \"FREELANCER_OPEN_TO_PERMANENT_CONTRACT\"\n ],\n \"excludeWithoutCv\": true,\n \"availableNow\": true,\n \"workedInStartup\": true,\n \"searchOnlyInMyTalentsATS\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.collective.work/{environment}/v1/sherlock/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"Senior fullstack engineer with 5+ years of React and Node.js, based in Paris, fintech experience\",\n \"contractTypes\": [\n \"FREELANCER\",\n \"FREELANCER_OPEN_TO_PERMANENT_CONTRACT\"\n ],\n \"excludeWithoutCv\": true,\n \"availableNow\": true,\n \"workedInStartup\": true,\n \"searchOnlyInMyTalentsATS\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.collective.work/{environment}/v1/sherlock/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"text\": \"Senior fullstack engineer with 5+ years of React and Node.js, based in Paris, fintech experience\",\n \"contractTypes\": [\n \"FREELANCER\",\n \"FREELANCER_OPEN_TO_PERMANENT_CONTRACT\"\n ],\n \"excludeWithoutCv\": true,\n \"availableNow\": true,\n \"workedInStartup\": true,\n \"searchOnlyInMyTalentsATS\": true\n}"
response = http.request(request)
puts response.read_body{
"searchId": "cm71yqftr00000ck0bpz3hpg1",
"status": "ONGOING"
}{
"message": [
"<string>"
],
"statusCode": 400,
"error": "Bad Request"
}{
"message": [
"<string>"
],
"statusCode": 403,
"error": "Forbidden"
}{
"message": [
"Internal server error"
],
"statusCode": 500,
"error": "Internal Server Error"
}Authorizations
Your organization API key, available in Organisation settings.
Body
Free-text brief describing the talent you are searching for
"Senior fullstack engineer with 5+ years of React and Node.js, based in Paris, fintech experience"
Restrict to one or more contract types: FREELANCER, FREELANCER_OPEN_TO_PERMANENT_CONTRACT (open to both freelance and permanent), or PERMANENT_CONTRACT. Buckets are independent and combine as a union (OR). Omit to include every contract type.
FREELANCER, FREELANCER_OPEN_TO_PERMANENT_CONTRACT, PERMANENT_CONTRACT [
"FREELANCER",
"FREELANCER_OPEN_TO_PERMANENT_CONTRACT"
]
Restrict the search to your own talents (the ones you imported into your ATS), excluding the wider Collective network. Scope note: this covers the ATS imports of the organization account this API key is attributed to, not necessarily every recruiter in the organization.
Was this page helpful?

