Skip to main content
POST
/
search-public
/
persons
Search persons (POST)
curl --request POST \
  --url https://lens-api.tic.io/search-public/persons \
  --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
}
'
import requests

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

payload = {
"collection": "<string>",
"q": "<string>",
"query_by": "<string>",
"filter_by": "<string>",
"sort_by": "<string>",
"per_page": 123,
"page": 123
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
collection: '<string>',
q: '<string>',
query_by: '<string>',
filter_by: '<string>',
sort_by: '<string>',
per_page: 123,
page: 123
})
};

fetch('https://lens-api.tic.io/search-public/persons', 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/persons",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'collection' => '<string>',
'q' => '<string>',
'query_by' => '<string>',
'filter_by' => '<string>',
'sort_by' => '<string>',
'per_page' => 123,
'page' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json",
"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"
"strings"
"net/http"
"io"
)

func main() {

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

payload := strings.NewReader("{\n \"collection\": \"<string>\",\n \"q\": \"<string>\",\n \"query_by\": \"<string>\",\n \"filter_by\": \"<string>\",\n \"sort_by\": \"<string>\",\n \"per_page\": 123,\n \"page\": 123\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json-patch+json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://lens-api.tic.io/search-public/persons")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"collection\": \"<string>\",\n \"q\": \"<string>\",\n \"query_by\": \"<string>\",\n \"filter_by\": \"<string>\",\n \"sort_by\": \"<string>\",\n \"per_page\": 123,\n \"page\": 123\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"collection\": \"<string>\",\n \"q\": \"<string>\",\n \"query_by\": \"<string>\",\n \"filter_by\": \"<string>\",\n \"sort_by\": \"<string>\",\n \"per_page\": 123,\n \"page\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "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>",
            "personId": 123,
            "personalIdentityNumber": "<string>",
            "allIdentities": [
              "<string>"
            ],
            "birthday": "<string>",
            "isProtected": true,
            "isCoordinationNumber": true,
            "givenName": "<string>",
            "firstName": "<string>",
            "middleName": "<string>",
            "lastName": "<string>",
            "fullName": "<string>",
            "spar": {
              "notificationRecordId": 123,
              "person_SenasteAndringSPAR": 123,
              "skydd_Sekretessmarkering": true,
              "skydd_SekretessmarkeringSattAvSPAR": true,
              "skydd_SekretessDatum": 123,
              "skydd_SkyddadFolkbokforing": true,
              "skydd_SkyddadFolkbokforingDatum": 123,
              "personDetaljer_SnIdentitetsnivaDatum": "<string>",
              "personDetaljer_SnTilldelningsdatum": "<string>",
              "personDetaljer_SnPreliminartVilandeforklaringsdatum": "<string>",
              "personDetaljer_SnFornyelsedatum": "<string>",
              "personDetaljer_SnVilandeorsak": "<string>",
              "personDetaljer_SnVilandeforklaringsdatum": "<string>",
              "personDetaljer_SnAvlidendatum": "<string>",
              "personDetaljer_SnStatus": "<string>",
              "personDetaljer_Sekretessmarkering": true,
              "personDetaljer_SekretessmarkeringSattAvSPAR": true,
              "personDetaljer_Avlidendatum": "<string>",
              "personDetaljer_AntraffadDodDatum": "<string>",
              "personDetaljer_AvregistreringsorsakKod": "<string>",
              "personDetaljer_Avregistreringsdatum": "<string>",
              "personDetaljer_SkyddadFolkbokforing": true,
              "personDetaljer_Fodelsedatum": 123,
              "folkbokforing_FolkbokfordLanKod": "<string>",
              "folkbokforing_FolkbokfordKommunKod": "<string>",
              "folkbokforing_Folkbokforingsdatum": 123,
              "folkbokforing_DistriktKod": "<string>",
              "folkbokforingsadress_SvenskAdress_CareOf": "<string>",
              "folkbokforingsadress_SvenskAdress_Utdelningsadress1": "<string>",
              "folkbokforingsadress_SvenskAdress_Utdelningsadress2": "<string>",
              "folkbokforingsadress_SvenskAdress_PostNr": "<string>",
              "folkbokforingsadress_SvenskAdress_Postort": "<string>",
              "utlandsadress_InternationellAdress_Utdelningsadress1": "<string>",
              "utlandsadress_InternationellAdress_Utdelningsadress2": "<string>",
              "utlandsadress_InternationellAdress_Utdelningsadress3": "<string>",
              "utlandsadress_InternationellAdress_Land": "<string>",
              "sarskildPostadress_SvenskAdress_CareOf": "<string>",
              "sarskildPostadress_SvenskAdress_Utdelningsadress1": "<string>",
              "sarskildPostadress_SvenskAdress_Utdelningsadress2": "<string>",
              "sarskildPostadress_SvenskAdress_PostNr": "<string>",
              "sarskildPostadress_SvenskAdress_Postort": "<string>",
              "sarskildPostadress_InternationellAdress_Utdelningsadress1": "<string>",
              "sarskildPostadress_InternationellAdress_Utdelningsadress2": "<string>",
              "sarskildPostadress_InternationellAdress_Utdelningsadress3": "<string>",
              "sarskildPostadress_InternationellAdress_Land": "<string>",
              "kontaktadress_SvenskAdress_CareOf": "<string>",
              "kontaktadress_SvenskAdress_Utdelningsadress1": "<string>",
              "kontaktadress_SvenskAdress_Utdelningsadress2": "<string>",
              "kontaktadress_SvenskAdress_PostNr": "<string>",
              "kontaktadress_SvenskAdress_Postort": "<string>",
              "kontaktadress_InternationellAdress_Utdelningsadress1": "<string>",
              "kontaktadress_InternationellAdress_Utdelningsadress2": "<string>",
              "kontaktadress_InternationellAdress_Utdelningsadress3": "<string>",
              "kontaktadress_InternationellAdress_Land": "<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>",
              "personId": 123,
              "personalIdentityNumber": "<string>",
              "allIdentities": [
                "<string>"
              ],
              "birthday": "<string>",
              "isProtected": true,
              "isCoordinationNumber": true,
              "givenName": "<string>",
              "firstName": "<string>",
              "middleName": "<string>",
              "lastName": "<string>",
              "fullName": "<string>",
              "spar": {
                "notificationRecordId": 123,
                "person_SenasteAndringSPAR": 123,
                "skydd_Sekretessmarkering": true,
                "skydd_SekretessmarkeringSattAvSPAR": true,
                "skydd_SekretessDatum": 123,
                "skydd_SkyddadFolkbokforing": true,
                "skydd_SkyddadFolkbokforingDatum": 123,
                "personDetaljer_SnIdentitetsnivaDatum": "<string>",
                "personDetaljer_SnTilldelningsdatum": "<string>",
                "personDetaljer_SnPreliminartVilandeforklaringsdatum": "<string>",
                "personDetaljer_SnFornyelsedatum": "<string>",
                "personDetaljer_SnVilandeorsak": "<string>",
                "personDetaljer_SnVilandeforklaringsdatum": "<string>",
                "personDetaljer_SnAvlidendatum": "<string>",
                "personDetaljer_SnStatus": "<string>",
                "personDetaljer_Sekretessmarkering": true,
                "personDetaljer_SekretessmarkeringSattAvSPAR": true,
                "personDetaljer_Avlidendatum": "<string>",
                "personDetaljer_AntraffadDodDatum": "<string>",
                "personDetaljer_AvregistreringsorsakKod": "<string>",
                "personDetaljer_Avregistreringsdatum": "<string>",
                "personDetaljer_SkyddadFolkbokforing": true,
                "personDetaljer_Fodelsedatum": 123,
                "folkbokforing_FolkbokfordLanKod": "<string>",
                "folkbokforing_FolkbokfordKommunKod": "<string>",
                "folkbokforing_Folkbokforingsdatum": 123,
                "folkbokforing_DistriktKod": "<string>",
                "folkbokforingsadress_SvenskAdress_CareOf": "<string>",
                "folkbokforingsadress_SvenskAdress_Utdelningsadress1": "<string>",
                "folkbokforingsadress_SvenskAdress_Utdelningsadress2": "<string>",
                "folkbokforingsadress_SvenskAdress_PostNr": "<string>",
                "folkbokforingsadress_SvenskAdress_Postort": "<string>",
                "utlandsadress_InternationellAdress_Utdelningsadress1": "<string>",
                "utlandsadress_InternationellAdress_Utdelningsadress2": "<string>",
                "utlandsadress_InternationellAdress_Utdelningsadress3": "<string>",
                "utlandsadress_InternationellAdress_Land": "<string>",
                "sarskildPostadress_SvenskAdress_CareOf": "<string>",
                "sarskildPostadress_SvenskAdress_Utdelningsadress1": "<string>",
                "sarskildPostadress_SvenskAdress_Utdelningsadress2": "<string>",
                "sarskildPostadress_SvenskAdress_PostNr": "<string>",
                "sarskildPostadress_SvenskAdress_Postort": "<string>",
                "sarskildPostadress_InternationellAdress_Utdelningsadress1": "<string>",
                "sarskildPostadress_InternationellAdress_Utdelningsadress2": "<string>",
                "sarskildPostadress_InternationellAdress_Utdelningsadress3": "<string>",
                "sarskildPostadress_InternationellAdress_Land": "<string>",
                "kontaktadress_SvenskAdress_CareOf": "<string>",
                "kontaktadress_SvenskAdress_Utdelningsadress1": "<string>",
                "kontaktadress_SvenskAdress_Utdelningsadress2": "<string>",
                "kontaktadress_SvenskAdress_PostNr": "<string>",
                "kontaktadress_SvenskAdress_Postort": "<string>",
                "kontaktadress_InternationellAdress_Utdelningsadress1": "<string>",
                "kontaktadress_InternationellAdress_Utdelningsadress2": "<string>",
                "kontaktadress_InternationellAdress_Utdelningsadress3": "<string>",
                "kontaktadress_InternationellAdress_Land": "<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
    }
  ]
}
Enterprise+ 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[]