Skip to main content
POST
Search

Authorizations

x-api-key
string
header
required

Your GOI API key. Create one on the GOI dashboard under API keys.

Body

application/json
similar_to
describe
string | null
keywords
KeywordsInput · object | null

BM25 / fulltext keyword filter applied to the company description.

Combines three lists with AND / OR / NOT logic. At least one positive list (must_all or must_any) is required when must_not is set — BM25 cannot match on pure negation.

filters
FiltersInput · object | null

Column-level filters applied to org rows.

Geographic fields use GADM-native names (e.g. 'Bayern' not 'Bavaria'). All list-valued filters are OR-combined within the field. Values across different fields are AND-combined.

excludes
string[]
columns
string[]
size
integer
default:100
Required range: 1 <= x <= 500
min_score
number
default:0.35
Required range: 0 <= x <= 1
search_balance
number
default:0.5
Required range: 0 <= x <= 1
search_after
any[] | null
explain
boolean
default:false
dedup
boolean
default:false

Response

Successful Response

data
Data · object[]
required
metadata
SearchMetadata · object
required

Diagnostics returned alongside /v1/search results.