Skip to main content
POST
/
api
/
v1
/
account
/
search-by-traits
Instant search on traits
curl --request POST \
  --url https://api.openfunnel.dev/api/v1/account/search-by-traits \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-User-ID: <x-user-id>' \
  --data '
{
  "query": "<string>",
  "limit": 25
}
'
{
  "query": "<string>",
  "results": [
    {
      "id": 123,
      "similarity": 123,
      "name": "<string>",
      "domain": "<string>",
      "description": "<string>",
      "technographics": {},
      "in_crm": false,
      "is_exported": false
    }
  ],
  "total": 123
}

Headers

X-API-Key
string
required
X-User-ID
string
required

Body

application/json

Request to search companies by traits/characteristics.

query
string
required

Describe the type of companies you're looking for

Required string length: 1 - 500
Examples:

"healthcare companies with voice AI products"

"fintech startups with payment processing"

"B2B SaaS companies in cybersecurity"

"companies that sell to restaurants"

limit
integer
default:25

Maximum number of results to return (1-100)

Required range: 1 <= x <= 100

Response

Successful Response

Response for trait search.

query
string
required

The search query that was executed

results
TraitSearchResult · object[]
required

List of matching accounts ranked by relevance

total
integer
required

Total number of results returned