Get Company Signal Filter Values

GET

companies

signals

filters

{filterType}

Get Company Signal Filter Values

curl --request GET \
  --url https://api.lusha.com/v3/companies/signals/filters/{filterType} \
  --header 'api_key: <api-key>'

const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://api.lusha.com/v3/companies/signals/filters/{filterType}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lusha.com/v3/companies/signals/filters/{filterType}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "values": [
    "Funding Round",
    "IPO",
    "Executive Hire",
    "Product Launch"
  ]
}

{
  "values": [
    "United States > California"
  ]
}

Returns the valid values for one company signal filter type. Call Get Company Signal Filters first if you need to discover which filterType values exist and whether each requires a query.

Endpoint

GET https://api.lusha.com/v3/companies/signals/filters/{filterType}

Authentication: API key (ApiKeyAuth)

Path parameters

string

required

The filter type to retrieve values for.Allowed values: newsEventTypes, hiringByDepartments, hiringByLocations

Query parameters

string

Text to match values against. 2–256 characters.

Filter type	Query required?
`newsEventTypes`	No
`hiringByDepartments`	No
`hiringByLocations`	Yes (2–256 chars)

hiringByLocations requires query - omitting it returns a 400. newsEventTypes and hiringByDepartments return their full value list whether or not you pass a query.

Example requests

curl --request GET \
  --url https://api.lusha.com/v3/companies/signals/filters/newsEventTypes \
  --header 'api_key: YOUR_API_KEY'

curl --request GET \
  --url https://api.lusha.com/v3/companies/signals/filters/hiringByDepartments \
  --header 'api_key: YOUR_API_KEY'

curl --request GET \
  --url 'https://api.lusha.com/v3/companies/signals/filters/hiringByLocations?query=California' \
  --header 'api_key: YOUR_API_KEY'

Response

200 - Success

any

The matching values for the requested filterType. Nullable - returns null when nothing matches.

The API’s FilterValuesResponse schema leaves values open-ended so it can represent different filter shapes. Treat the response as authoritative and read it directly rather than hardcoding a shape - the example below is illustrative.

{
  "values": [
    "Funding Round",
    "IPO",
    "Executive Hire",
    "Product Launch"
  ]
}

{
  "values": [
    "United States > California"
  ]
}

Error codes

Status	Meaning
`400`	Bad request - `filterType` is invalid, or `query` is missing/too short/too long for `hiringByLocations`.
`401`	Unauthorized - your API key is missing or invalid.
`403`	Forbidden - account inactive or V3 access not enabled.

Get Company Signal Filters - discover which filter types are available
Company Signals - retrieve signal events for specific companies

Authorizations

api_key

string

header

required

Your Lusha API key. You can find this in your Lusha dashboard under API settings. Include this key in the api_key header for all requests.

Path Parameters

filterType

enum<string>

required

Available options:

newsEventTypes,

hiringByDepartments,

hiringByLocations,

intentCategories

Query Parameters

query

string

Required string length: 2 - 256

Response

Successful response

values

any | null

Filter values (shape depends on filter type)

⌘I

Get Company Signal Filter Values

curl --request GET \
  --url https://api.lusha.com/v3/companies/signals/filters/{filterType} \
  --header 'api_key: <api-key>'

const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://api.lusha.com/v3/companies/signals/filters/{filterType}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lusha.com/v3/companies/signals/filters/{filterType}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "values": [
    "Funding Round",
    "IPO",
    "Executive Hire",
    "Product Launch"
  ]
}

{
  "values": [
    "United States > California"
  ]
}

Overview

Resources

Endpoints

Endpoint

Path parameters

Query parameters

Example requests

Response

200 - Success

Error codes

Authorizations

Path Parameters

Query Parameters

Response

​Endpoint

​Path parameters

​Query parameters

​Example requests

​Response

​200 - Success

​Error codes

​Related pages

Authorizations

Path Parameters

Query Parameters

Response

Endpoint

Path parameters

Query parameters

Example requests

Response

200 - Success

Error codes

Related pages