curl --request GET \
--url https://api.tryfuse.ai/api/v1/business/prospects/filter-options \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.tryfuse.ai/api/v1/business/prospects/filter-options"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.tryfuse.ai/api/v1/business/prospects/filter-options', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"filterOptions": {
"fields": {
"job_title_levels": {
"valueShape": "include_exclude",
"values": [
{
"label": "CXO",
"value": "cxo"
},
{
"label": "Director",
"value": "director"
},
{
"label": "Entry",
"value": "entry"
},
{
"label": "Manager",
"value": "manager"
},
{
"label": "Owner",
"value": "owner"
},
{
"label": "Partner",
"value": "partner"
},
{
"label": "Senior",
"value": "senior"
},
{
"label": "Training",
"value": "training"
},
{
"label": "Unpaid",
"value": "unpaid"
},
{
"label": "VP",
"value": "vp"
}
]
},
"job_company_name": {
"valueShape": "include_exclude",
"values": []
},
"job_title": {
"valueShape": "term",
"values": []
}
},
"jobTitleRoleToSubRole": {
"advisory": [
"advisor",
"board_member",
"investor"
],
"finance": [
"accounting",
"bookkeeping",
"planning_and_analysis",
"procurement",
"risk"
]
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}Get the accepted prospect-search filter values
Get the valid values for one people-search filter (seniority, department, industry, country, company size, revenue, language, degree) or for all of them. Free. Send field, e.g. job_title_levels, for that filter alone; without it the whole contract comes back, all 33 filters (about 68 KB). The whole people-search filter contract, keyed by search field name. fields.<field>.valueShape says how that field’s value must be shaped on the wire — include_exclude takes [{ status, value }] entries, or a bare string / array of strings (bare strings are includes), term takes a string or an array of strings — and fields.<field>.values lists the accepted { label, value } pairs (send value). Free-text fields such as job_title or location_name have no vocabulary and come back with values: [], plus autocomplete when GET /prospects/autocomplete suggests their values (append &q= and the text). jobTitleRoleToSubRole (only without field) maps every job_title_role to the job_title_sub_role values beneath it (deprecated: sub-department is no longer a search filter, but rows still carry it). Filters the search no longer serves are not listed, and POST /prospects/search refuses them with 422 VALIDATION_FAILED. A static vocabulary generated from the provider’s schema: no tenant data, no credits, and callable with any valid token regardless of scope. Values outside a field’s vocabulary match nothing, so POST /prospects/search rejects them with 422 before anything is billed.
Errors:
429RATE_LIMITED— Per-token rate limit for this bucket exhausted; retry after the window in the RateLimit-Reset header.500UNEXPECTED_ERROR— The request failed inside the service; nothing was billed and the request_id identifies the failure.
curl --request GET \
--url https://api.tryfuse.ai/api/v1/business/prospects/filter-options \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.tryfuse.ai/api/v1/business/prospects/filter-options"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.tryfuse.ai/api/v1/business/prospects/filter-options', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"filterOptions": {
"fields": {
"job_title_levels": {
"valueShape": "include_exclude",
"values": [
{
"label": "CXO",
"value": "cxo"
},
{
"label": "Director",
"value": "director"
},
{
"label": "Entry",
"value": "entry"
},
{
"label": "Manager",
"value": "manager"
},
{
"label": "Owner",
"value": "owner"
},
{
"label": "Partner",
"value": "partner"
},
{
"label": "Senior",
"value": "senior"
},
{
"label": "Training",
"value": "training"
},
{
"label": "Unpaid",
"value": "unpaid"
},
{
"label": "VP",
"value": "vp"
}
]
},
"job_company_name": {
"valueShape": "include_exclude",
"values": []
},
"job_title": {
"valueShape": "term",
"values": []
}
},
"jobTitleRoleToSubRole": {
"advisory": [
"advisor",
"board_member",
"investor"
],
"finance": [
"accounting",
"bookkeeping",
"planning_and_analysis",
"procurement",
"risk"
]
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}Authorizations
Your API token (af_…) as the Basic-auth username, with an empty password.
Query Parameters
One filter to answer for, by its search field name (e.g. job_title_levels); omitted, every filter is answered.
industry, job_title_levels, job_title_role, job_company_size, job_company_inferred_revenue, job_company_industry, job_company_location_country, job_company_location_region, experience.title.levels, experience.title.role, languages.name, location_country, location_region, education.degrees, job_company_name, job_company_website, linkedin_url, experience.company.name, full_name, first_name, last_name, work_email, personal_emails, mobile_phone, job_title, job_company_location_name, location_name, education.school.name, experience.title.name, experience.company.website, job_start_date, skills, certifications.name Response
Success
Show child attributes
Show child attributes