Search
Get a search
The full state of one search: the record itself, per-stage run history, and ranked candidates. Client-mode searches additionally return discovered companies and decision-maker leads.
Poll this while scan.status is running.
GET
/
api
/
scans
/
{id}
Get a search
curl --request GET \
--url https://api.revcenter.ai/api/scans/{id} \
--cookie session=const options = {method: 'GET', headers: {cookie: 'session='}};
fetch('https://api.revcenter.ai/api/scans/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.revcenter.ai/api/scans/{id}"
headers = {"cookie": "session="}
response = requests.get(url, headers=headers)
print(response.text){
"scan": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"status": "queued",
"sector": "<string>",
"pulled": 123,
"target_count": 123,
"raw_input": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"closed_at": "2023-11-07T05:31:56Z",
"error": "<string>",
"mode": "candidate",
"criteria": {
"family": "<string>",
"title_variants": [
"<string>"
],
"seniority": "c_suite",
"allowed_seniority": [
"c_suite"
],
"must_have": [
"<string>"
],
"industries": [
"<string>"
],
"metro": "San Jose, CA",
"geo_radius_mi": 123,
"remote_ok": true,
"exclude_titles": [
"<string>"
],
"exclude_industries": [
"<string>"
],
"exclude_companies": [
"<string>"
],
"avoid_titles": [
"<string>"
],
"avoid_industries": [
"<string>"
],
"avoid_companies": [
"<string>"
],
"comp_band": [
123
],
"years_experience": {
"min": 123,
"max": 123
},
"min_avg_tenure_years": 123,
"skills": [
"<string>"
],
"skills_required": [
"<string>"
],
"languages_required": [
"<string>"
],
"target_company_profile": {
"sector": "<string>",
"employee_range": [
123
],
"pe_backed_preferred": true
},
"rubric_weights": {
"title": 123,
"years": 123,
"skills": 123,
"geo": 123,
"industry": 123,
"seniority": 123
}
},
"qualified": 123,
"quality_report": {}
},
"runs": [
{
"id": "<string>",
"stage": "serp",
"status": "complete",
"items_in": 123,
"items_out": 123,
"error": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z"
}
],
"candidates": [
{
"rank": 123,
"score": 123,
"subscores": {},
"phase": "<string>",
"verdict": "accept",
"candidate": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"roleTitle": "<string>",
"company": "<string>",
"metro": "<string>",
"profileUrl": "<string>",
"photoUrl": "<string>",
"headline": "<string>",
"email": "<string>",
"phone": "<string>",
"hydrated": true,
"signals": [
{}
]
}
}
],
"companies": [
{}
],
"clientLeads": [
{}
],
"access": {
"canShare": true
}
}{
"error": "Sign in required"
}{
"error": "Scan not found"
}{
"error": "Spec extraction failed"
}Authorizations
A signed-in workspace session, sent as a browser cookie. Requests must include credentials, and act on the session's active workspace.
Path Parameters
The search ID.
⌘I
Get a search
curl --request GET \
--url https://api.revcenter.ai/api/scans/{id} \
--cookie session=const options = {method: 'GET', headers: {cookie: 'session='}};
fetch('https://api.revcenter.ai/api/scans/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.revcenter.ai/api/scans/{id}"
headers = {"cookie": "session="}
response = requests.get(url, headers=headers)
print(response.text){
"scan": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"status": "queued",
"sector": "<string>",
"pulled": 123,
"target_count": 123,
"raw_input": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"closed_at": "2023-11-07T05:31:56Z",
"error": "<string>",
"mode": "candidate",
"criteria": {
"family": "<string>",
"title_variants": [
"<string>"
],
"seniority": "c_suite",
"allowed_seniority": [
"c_suite"
],
"must_have": [
"<string>"
],
"industries": [
"<string>"
],
"metro": "San Jose, CA",
"geo_radius_mi": 123,
"remote_ok": true,
"exclude_titles": [
"<string>"
],
"exclude_industries": [
"<string>"
],
"exclude_companies": [
"<string>"
],
"avoid_titles": [
"<string>"
],
"avoid_industries": [
"<string>"
],
"avoid_companies": [
"<string>"
],
"comp_band": [
123
],
"years_experience": {
"min": 123,
"max": 123
},
"min_avg_tenure_years": 123,
"skills": [
"<string>"
],
"skills_required": [
"<string>"
],
"languages_required": [
"<string>"
],
"target_company_profile": {
"sector": "<string>",
"employee_range": [
123
],
"pe_backed_preferred": true
},
"rubric_weights": {
"title": 123,
"years": 123,
"skills": 123,
"geo": 123,
"industry": 123,
"seniority": 123
}
},
"qualified": 123,
"quality_report": {}
},
"runs": [
{
"id": "<string>",
"stage": "serp",
"status": "complete",
"items_in": 123,
"items_out": 123,
"error": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z"
}
],
"candidates": [
{
"rank": 123,
"score": 123,
"subscores": {},
"phase": "<string>",
"verdict": "accept",
"candidate": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"roleTitle": "<string>",
"company": "<string>",
"metro": "<string>",
"profileUrl": "<string>",
"photoUrl": "<string>",
"headline": "<string>",
"email": "<string>",
"phone": "<string>",
"hydrated": true,
"signals": [
{}
]
}
}
],
"companies": [
{}
],
"clientLeads": [
{}
],
"access": {
"canShare": true
}
}{
"error": "Sign in required"
}{
"error": "Scan not found"
}{
"error": "Spec extraction failed"
}