Skip to main content
GET
/
search-public
/
workplaces
Search workplaces (GET)
curl --request GET \
  --url https://lens-api.tic.io/search-public/workplaces \
  --header 'x-api-key: <api-key>'
import requests

url = "https://lens-api.tic.io/search-public/workplaces"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://lens-api.tic.io/search-public/workplaces', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://lens-api.tic.io/search-public/workplaces",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://lens-api.tic.io/search-public/workplaces"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://lens-api.tic.io/search-public/workplaces")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://lens-api.tic.io/search-public/workplaces")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "facet_counts": [
    {
      "counts": [
        {
          "count": 123,
          "highlighted": "<string>",
          "value": "<string>"
        }
      ],
      "field_name": "<string>",
      "sampled": true,
      "stats": {
        "total_values": 123
      },
      "localizedFieldName": "<string>"
    }
  ],
  "found": 123,
  "hits": [
    {
      "document": {
        "id": "<string>",
        "companyWorkplaceId": 123,
        "workplaceCode": 123,
        "firstSeenAt": 123,
        "workplaceCompanies": [
          {
            "companyId": 123,
            "fromDate": 123,
            "toDate": 123,
            "registrationNumber": "<string>",
            "mostRecentName": "<string>",
            "legalEntityType": "<string>",
            "localCompanyCode": "<string>",
            "elfCode": "<string>",
            "registrationDate": 123,
            "ceasedDate": 123,
            "isCeased": true
          }
        ],
        "workplaceUnits": [
          {
            "companyId": 123,
            "unitIdentifier": 123,
            "firstSeenAt": 123,
            "lastSeenAt": 123
          }
        ],
        "workplaceName": [
          {
            "nameOrIdentifier": "<string>",
            "firstSeenAt": 123,
            "lastSeenAt": 123
          }
        ],
        "workplaceType": 123,
        "workplaceTypeDescriptionSv": "<string>",
        "employeesRangeType": 123,
        "employeesRangeTypeDescriptionSv": "<string>",
        "mostRecentVisitingAddress": {
          "co": "<string>",
          "streetAddress": "<string>",
          "postalCode": "<string>",
          "city": "<string>",
          "countryCodeAlpha3": "<string>",
          "location": [
            123
          ],
          "firstSeenAt": 123,
          "lantmaterietLocationalAddressId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "lantmaterietLocatedOnPropertyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "lantmaterietLocationalSupplementalNumber": "<string>",
          "municipalityCode": "<string>",
          "countyCode": "<string>",
          "nyko": "<string>",
          "nykoYear": 123,
          "addressId": 123
        },
        "mostRecentMailingAddress": {
          "co": "<string>",
          "streetAddress": "<string>",
          "postalCode": "<string>",
          "city": "<string>",
          "countryCodeAlpha3": "<string>",
          "location": [
            123
          ],
          "firstSeenAt": 123,
          "lantmaterietLocationalAddressId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "lantmaterietLocatedOnPropertyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "lantmaterietLocationalSupplementalNumber": "<string>",
          "municipalityCode": "<string>",
          "countyCode": "<string>",
          "nyko": "<string>",
          "nykoYear": 123,
          "addressId": 123
        },
        "sniCodes": [
          {
            "sni_2007Code": "<string>",
            "sni_2007Name": "<string>",
            "sni_2007Section": "<string>",
            "sni_2025Code": "<string>",
            "sni_2025Name": "<string>",
            "sni_2025Section": "<string>",
            "rank": 123
          }
        ],
        "status": [
          {
            "statusDate": 123,
            "statusDescription": "<string>"
          }
        ]
      },
      "geo_distance_meters": null,
      "highlight": null,
      "highlights": [
        {
          "field": "<string>",
          "matched_tokens": [
            "<string>"
          ],
          "snippet": "<string>"
        }
      ],
      "text_match": 123,
      "text_match_info": {
        "best_field_score": "<string>",
        "best_field_weight": 123,
        "fields_matched": 123,
        "num_tokens_dropped": 123,
        "score": "<string>",
        "tokens_matched": 123,
        "typo_prefix_score": 123
      }
    }
  ],
  "grouped_hits": {
    "group_key": [
      "<string>"
    ],
    "hits": [
      {
        "document": {
          "id": "<string>",
          "companyWorkplaceId": 123,
          "workplaceCode": 123,
          "firstSeenAt": 123,
          "workplaceCompanies": [
            {
              "companyId": 123,
              "fromDate": 123,
              "toDate": 123,
              "registrationNumber": "<string>",
              "mostRecentName": "<string>",
              "legalEntityType": "<string>",
              "localCompanyCode": "<string>",
              "elfCode": "<string>",
              "registrationDate": 123,
              "ceasedDate": 123,
              "isCeased": true
            }
          ],
          "workplaceUnits": [
            {
              "companyId": 123,
              "unitIdentifier": 123,
              "firstSeenAt": 123,
              "lastSeenAt": 123
            }
          ],
          "workplaceName": [
            {
              "nameOrIdentifier": "<string>",
              "firstSeenAt": 123,
              "lastSeenAt": 123
            }
          ],
          "workplaceType": 123,
          "workplaceTypeDescriptionSv": "<string>",
          "employeesRangeType": 123,
          "employeesRangeTypeDescriptionSv": "<string>",
          "mostRecentVisitingAddress": {
            "co": "<string>",
            "streetAddress": "<string>",
            "postalCode": "<string>",
            "city": "<string>",
            "countryCodeAlpha3": "<string>",
            "location": [
              123
            ],
            "firstSeenAt": 123,
            "lantmaterietLocationalAddressId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "lantmaterietLocatedOnPropertyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "lantmaterietLocationalSupplementalNumber": "<string>",
            "municipalityCode": "<string>",
            "countyCode": "<string>",
            "nyko": "<string>",
            "nykoYear": 123,
            "addressId": 123
          },
          "mostRecentMailingAddress": {
            "co": "<string>",
            "streetAddress": "<string>",
            "postalCode": "<string>",
            "city": "<string>",
            "countryCodeAlpha3": "<string>",
            "location": [
              123
            ],
            "firstSeenAt": 123,
            "lantmaterietLocationalAddressId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "lantmaterietLocatedOnPropertyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "lantmaterietLocationalSupplementalNumber": "<string>",
            "municipalityCode": "<string>",
            "countyCode": "<string>",
            "nyko": "<string>",
            "nykoYear": 123,
            "addressId": 123
          },
          "sniCodes": [
            {
              "sni_2007Code": "<string>",
              "sni_2007Name": "<string>",
              "sni_2007Section": "<string>",
              "sni_2025Code": "<string>",
              "sni_2025Name": "<string>",
              "sni_2025Section": "<string>",
              "rank": 123
            }
          ],
          "status": [
            {
              "statusDate": 123,
              "statusDescription": "<string>"
            }
          ]
        },
        "geo_distance_meters": null,
        "highlight": null,
        "highlights": [
          {
            "field": "<string>",
            "matched_tokens": [
              "<string>"
            ],
            "snippet": "<string>"
          }
        ],
        "text_match": 123,
        "text_match_info": {
          "best_field_score": "<string>",
          "best_field_weight": 123,
          "fields_matched": 123,
          "num_tokens_dropped": 123,
          "score": "<string>",
          "tokens_matched": 123,
          "typo_prefix_score": 123
        }
      }
    ]
  },
  "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
}
Max+ tier

Authorizations

x-api-key
string
header
required

Response

Typesense search response

facet_counts
null | object[]
found
integer<int32>
hits
null | object[]
grouped_hits
object
out_of
integer<int32>
page
integer<int32>
request_params
object
search_cutoff
null | boolean
search_time_ms
integer<int32>