Get Company Signal Filters (Discovery)

GET

companies

signals

filters

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

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

fetch('https://api.lusha.com/v3/companies/signals/filters', 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"

	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))

}

{
  "availableFilters": [
    { "filterType": "newsEventTypes", "requiresQuery": false },
    { "filterType": "hiringByDepartments", "requiresQuery": false },
    { "filterType": "hiringByLocations", "requiresQuery": true }
  ]
}

This is the discovery endpoint for company signal filters. Call it first to learn which filter types exist and whether each one needs a query string - then call Get Company Signal Filter Values with a specific filterType to retrieve the actual values.

Endpoint

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

Authentication: API key (ApiKeyAuth) This endpoint has no parameters.

Example request

cURL

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

Response

200 - Success

object[]

One entry per available filter type.

Show properties

string

The filter type identifier. Pass this value as the filterType path parameter on Get Company Signal Filter Values.

boolean

Whether you must supply a query parameter when fetching values for this filter type.

{
  "availableFilters": [
    { "filterType": "newsEventTypes", "requiresQuery": false },
    { "filterType": "hiringByDepartments", "requiresQuery": false },
    { "filterType": "hiringByLocations", "requiresQuery": true }
  ]
}

hiringByLocations requires a query of 2–256 characters - it’s a text-search filter rather than a fixed list. newsEventTypes and hiringByDepartments return their full value list without a query.

Error codes

Status	Meaning
`401`	Unauthorized - your API key is missing or invalid.
`403`	Forbidden - account inactive or V3 access not enabled.

Get Company Signal Filter Values - retrieve the value list for a specific filter type
Get Company Signal Types - the full list of signalTypes these filter categories relate to
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.

Response

Successful response

availableFilters

object[]

Show child attributes

⌘I

Get Company Signal Filters (Discovery)

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

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

fetch('https://api.lusha.com/v3/companies/signals/filters', 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"

	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))

}

{
  "availableFilters": [
    { "filterType": "newsEventTypes", "requiresQuery": false },
    { "filterType": "hiringByDepartments", "requiresQuery": false },
    { "filterType": "hiringByLocations", "requiresQuery": true }
  ]
}

Overview

Resources

Endpoints

Get Company Signal Filters (Discovery)

Endpoint

Example request

Response

200 - Success

Error codes

Authorizations

Response

​Endpoint

​Example request

​Response

​200 - Success

​Error codes

​Related pages

Authorizations

Response

Endpoint

Example request

Response

200 - Success

Error codes

Related pages