Skip to main content
POST
/
api
/
v1
/
account
/
search-by-name-or-domain
Search Accounts By Name Or Domain
curl --request POST \
  --url https://api.openfunnel.dev/api/v1/account/search-by-name-or-domain \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-User-ID: <x-user-id>' \
  --data '
{
  "query": "<string>",
  "limit": 10
}
'
{
  "query": "<string>",
  "matches": [
    {
      "id": 123,
      "name": "<string>",
      "domain": "<string>",
      "employee_count": 123,
      "funding_stage": "<string>",
      "industry": "<string>"
    }
  ],
  "total_matches": 0,
  "unique_domains": 0,
  "needs_clarification": false
}

Headers

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

Body

application/json

Request to search accounts by name or domain.

query
string
required

Search query to match against account name or domain

Required string length: 1 - 200
limit
integer
default:10

Maximum number of results to return (1-50)

Required range: 1 <= x <= 50

Response

Successful Response

Response for account search.

query
string
required

The search query that was executed

matches
AccountSearchResult · object[]

List of matching accounts

total_matches
integer
default:0

Total number of matches found

unique_domains
integer
default:0

Number of unique domains in results

needs_clarification
boolean
default:false

True if multiple accounts with different domains match - user should clarify which one