Search workplaces (POST)

Max+ tier

POSThttps://lens-api.tic.io/search-public/workplaces

Authorization

x-api-keystringheaderrequired

Your API key, sent in the x-api-key header.

Bodyapplication/json

collectionstring | null

qstring | null

query_bystring | null

filter_bystring | null

sort_bystring | null

per_pageinteger | null

format: int32

pageinteger | null

format: int32

include_fieldsstring | null

exclude_fieldsstring | null

Responses

Typesense multi-search response · application/json

resultsTypesenseCompanyWorkplaceTypesenseSearchResponse[] | null

Hide child attributes

facet_countsTypesenseFacetCounts[] | null

Show child attributes

countsTypesenseFacetCountDetails[] | null

Show child attributes

countinteger

format: int64

highlightedstring | null

valuestring | null

field_namestring | null

sampledboolean

statsTypesenseFacetCountsStats

Show child attributes

total_valuesinteger

format: int64

localizedFieldNamestring | nullread-only

foundinteger

format: int32

hitsTypesenseCompanyWorkplaceHit[] | null

Show child attributes

documentTypesenseCompanyWorkplace

Show child attributes

idstring | null

companyWorkplaceIdinteger

format: int32

workplaceCodeinteger | null

format: int32

firstSeenAtinteger | null

format: int64

workplaceCompaniesCompanyWorkplaceCompany[] | null

Show child attributes

companyIdinteger

format: int32

fromDateinteger | null

format: int64

toDateinteger | null

format: int64

registrationNumberstring | null

mostRecentNamestring | null

legalEntityTypestring | null

localCompanyCodestring | null

elfCodestring | null

registrationDateinteger | null

format: int64

ceasedDateinteger | null

format: int64

isCeasedboolean

workplaceUnitsCompanyWorkplaceUnit[] | null

Show child attributes

companyIdinteger

format: int32

unitIdentifierinteger

format: int32

firstSeenAtinteger | null

format: int64

lastSeenAtinteger | null

format: int64

workplaceNameCompanyWorkplaceName[] | null

Show child attributes

nameOrIdentifierstring | null

firstSeenAtinteger | null

format: int64

lastSeenAtinteger | null

format: int64

workplaceTypeinteger | null

format: int32

workplaceTypeDescriptionSvstring | null

employeesRangeTypeinteger | null

format: int32

employeesRangeTypeDescriptionSvstring | null

mostRecentVisitingAddressCompanyWorkplaceAddressGeopoint

Show child attributes

costring | null

streetAddressstring | null

postalCodestring | nullread-only

citystring | nullread-only

countryCodeAlpha3string | null

locationnumber[] | nullread-only

firstSeenAtinteger | null

format: int64

lantmaterietLocationalAddressIdstring | null

format: uuid

lantmaterietLocatedOnPropertyIdstring | null

format: uuid

lantmaterietLocationalSupplementalNumberstring | null

municipalityCodestring | null

countyCodestring | null

nykostring | null

nykoYearinteger | null

format: int32

addressIdinteger | null

format: int32

mostRecentMailingAddressCompanyWorkplaceAddressGeopoint

Show child attributes

costring | null

streetAddressstring | null

postalCodestring | nullread-only

citystring | nullread-only

countryCodeAlpha3string | null

locationnumber[] | nullread-only

firstSeenAtinteger | null

format: int64

lantmaterietLocationalAddressIdstring | null

format: uuid

lantmaterietLocatedOnPropertyIdstring | null

format: uuid

lantmaterietLocationalSupplementalNumberstring | null

municipalityCodestring | null

countyCodestring | null

nykostring | null

nykoYearinteger | null

format: int32

addressIdinteger | null

format: int32

sniCodesCompanyWorkplaceIndustryCode[] | null

Show child attributes

sni_2007Codestring | null

sni_2007Namestring | null

sni_2007Sectionstring | null

sni_2025Codestring | null

sni_2025Namestring | null

sni_2025Sectionstring | null

rankinteger | null

format: int32

statusCompanyWorkplaceStatus[] | null

Show child attributes

statusTypestring

One of: isActive isNoLongerActive hasNeverBeenActive

statusDateinteger | null

format: int64

statusDescriptionstring | null

geo_distance_metersany

highlightany

highlightsHighlightElement[] | null

Show child attributes

fieldstring | null

matched_tokensstring[] | null

snippetstring | null

text_matchnumber | null

format: double

text_match_infoTextMatchInfo

Show child attributes

best_field_scorestring | null

best_field_weightinteger | null

format: int64

fields_matchedinteger | null

format: int64

num_tokens_droppedinteger | null

format: int64

scorestring | null

tokens_matchedinteger | null

format: int64

typo_prefix_scoreinteger | null

format: int64

grouped_hitsTypesenseCompanyWorkplaceGroupedHits

Show child attributes

group_keystring[] | null

hitsTypesenseCompanyWorkplaceHit[] | null

Show child attributes

documentTypesenseCompanyWorkplace

Show child attributes

idstring | null

companyWorkplaceIdinteger

format: int32

workplaceCodeinteger | null

format: int32

firstSeenAtinteger | null

format: int64

workplaceCompaniesCompanyWorkplaceCompany[] | null

workplaceUnitsCompanyWorkplaceUnit[] | null

workplaceNameCompanyWorkplaceName[] | null

workplaceTypeinteger | null

format: int32

workplaceTypeDescriptionSvstring | null

employeesRangeTypeinteger | null

format: int32

employeesRangeTypeDescriptionSvstring | null

mostRecentVisitingAddressCompanyWorkplaceAddressGeopoint

Nested structure omitted at this depth.

mostRecentMailingAddressCompanyWorkplaceAddressGeopoint

Nested structure omitted at this depth.

sniCodesCompanyWorkplaceIndustryCode[] | null

statusCompanyWorkplaceStatus[] | null

geo_distance_metersany

highlightany

highlightsHighlightElement[] | null

Show child attributes

fieldstring | null

matched_tokensstring[] | null

snippetstring | null

text_matchnumber | null

format: double

text_match_infoTextMatchInfo

Show child attributes

best_field_scorestring | null

best_field_weightinteger | null

format: int64

fields_matchedinteger | null

format: int64

num_tokens_droppedinteger | null

format: int64

scorestring | null

tokens_matchedinteger | null

format: int64

typo_prefix_scoreinteger | null

format: int64

out_ofinteger

format: int32

pageinteger

format: int32

request_paramsRequestParams

Show child attributes

collection_namestring | null

first_qstring | null

per_pageinteger | null

format: int64

qstring | null

search_cutoffboolean | null

search_time_msinteger

format: int32

Query builder

Compose query_by, filter_by and sort_by from the collection's fields and run the search through the proxy.

Authorization

Stored in this browser only (until you forget it) and sent as the x-api-key header through the documentation proxy.

q query text, * for all

query_by fields searched

workplaceCompanies.registrationNumber

filter_by

sort_by

per_page

page

include_fields comma separated

exclude_fields

Request

curl -X POST "https://lens-api.tic.io/search-public/workplaces" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "q": "*",
  "query_by": "workplaceCompanies.registrationNumber",
  "per_page": 10,
  "page": 1
}'

Enter your API key to run.

curl -X POST "https://lens-api.tic.io/search-public/workplaces" \ -H "x-api-key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "collection": "<string>", "q": "<string>", "query_by": "<string>", "filter_by": "<string>", "sort_by": "<string>", "per_page": 123, "page": 123, "include_fields": "<string>", "exclude_fields": "<string>" }'

{ "results": [ { "facet_counts": [ { "counts": [ {} ], "field_name": "<string>", "sampled": true, "stats": {}, "localizedFieldName": "<string>" } ], "found": 123, "hits": [ { "document": {}, "geo_distance_meters": null, "highlight": null, "highlights": [ {} ], "text_match": 123.45, "text_match_info": {} } ], "grouped_hits": { "group_key": [ "<string>" ], "hits": [ {} ] }, "out_of": 123, "page": 123, "request_params": { "collection_name": "<string>", "first_q": "<string>", "per_page": 123, "q": "<string>" }, "search_cutoff": true, "search_time_ms": 123 } ] }