Skip to main content
POST
/
search-public
/
workplaces
Search workplaces (POST)
curl --request POST \
  --url https://lens-api.tic.io/search-public/workplaces \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "collection": "<string>",
  "q": "<string>",
  "query_by": "<string>",
  "filter_by": "<string>",
  "sort_by": "<string>",
  "per_page": 123,
  "page": 123
}
'
{
  "results": [
    {
      "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": [
              {
                "statusType": "isActive",
                "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": [
                {
                  "statusType": "isActive",
                  "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

Body

collection
null | string
q
null | string
query_by
null | string
filter_by
null | string
sort_by
null | string
per_page
null | integer<int32>
page
null | integer<int32>

Response

Typesense multi-search response

results
null | object[]