Search persons (POST)

Enterprise+ tier

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

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

resultsTypesensePersonDocumentTypesenseSearchResponse[] | 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

hitsTypesensePersonDocumentHit[] | null

Show child attributes

documentTypesensePersonDocument

Show child attributes

idstring | null

personIdinteger

format: int32

personalIdentityNumberstring | null

allIdentitiesstring[] | null

birthdaystring | null

isProtectedboolean

isCoordinationNumberboolean | null

givenNamestring | null

firstNamestring | null

middleNamestring | null

lastNamestring | null

fullNamestring | null

sexstring

One of: male female

sparRecord

Show child attributes

notificationRecordIdinteger | null

format: int32

person_PersonIdTypstring

One of: personnummer samordningsnummer immunitetsnummer

person_SenasteAndringSPARinteger | null

format: int64

skydd_Sekretessmarkeringboolean | null

skydd_SekretessmarkeringSattAvSPARboolean | null

skydd_SekretessDatuminteger | null

format: int64

skydd_SkyddadFolkbokforingboolean | null

skydd_SkyddadFolkbokforingDatuminteger | null

format: int64

personDetaljer_SnIdentitetsnivastring

One of: styrkt sannolik osaker inteTillamplig

personDetaljer_SnIdentitetsnivaDatumstring | null

personDetaljer_SnTilldelningsdatumstring | null

personDetaljer_SnPreliminartVilandeforklaringsdatumstring | null

personDetaljer_SnFornyelsedatumstring | null

personDetaljer_SnVilandeorsakstring | null

personDetaljer_SnVilandeforklaringsdatumstring | null

personDetaljer_SnAvlidendatumstring | null

personDetaljer_SnStatusstring | null

personDetaljer_Sekretessmarkeringboolean | null

personDetaljer_SekretessmarkeringSattAvSPARboolean | null

personDetaljer_Avlidendatumstring | null

personDetaljer_AntraffadDodDatumstring | null

personDetaljer_AvregistreringsorsakKodstring | null

personDetaljer_Avregistreringsdatumstring | null

personDetaljer_SkyddadFolkbokforingboolean | null

personDetaljer_Fodelsedatuminteger | null

format: int64

folkbokforing_FolkbokfordLanKodstring | null

folkbokforing_FolkbokfordKommunKodstring | null

folkbokforing_HemvistTypstring

One of: skrivenPaAdressen paKommunenSkriven utanKantHemvist

folkbokforing_Folkbokforingsdatuminteger | null

format: int64

folkbokforing_DistriktKodstring | null

folkbokforingsadress_SvenskAdress_CareOfstring | null

folkbokforingsadress_SvenskAdress_Utdelningsadress1string | null

folkbokforingsadress_SvenskAdress_Utdelningsadress2string | null

folkbokforingsadress_SvenskAdress_PostNrstring | null

folkbokforingsadress_SvenskAdress_Postortstring | null

utlandsadress_InternationellAdress_Utdelningsadress1string | null

utlandsadress_InternationellAdress_Utdelningsadress2string | null

utlandsadress_InternationellAdress_Utdelningsadress3string | null

utlandsadress_InternationellAdress_Landstring | null

sarskildPostadress_SvenskAdress_CareOfstring | null

sarskildPostadress_SvenskAdress_Utdelningsadress1string | null

sarskildPostadress_SvenskAdress_Utdelningsadress2string | null

sarskildPostadress_SvenskAdress_PostNrstring | null

sarskildPostadress_SvenskAdress_Postortstring | null

sarskildPostadress_InternationellAdress_Utdelningsadress1string | null

sarskildPostadress_InternationellAdress_Utdelningsadress2string | null

sarskildPostadress_InternationellAdress_Utdelningsadress3string | null

sarskildPostadress_InternationellAdress_Landstring | null

kontaktadress_SvenskAdress_CareOfstring | null

kontaktadress_SvenskAdress_Utdelningsadress1string | null

kontaktadress_SvenskAdress_Utdelningsadress2string | null

kontaktadress_SvenskAdress_PostNrstring | null

kontaktadress_SvenskAdress_Postortstring | null

kontaktadress_InternationellAdress_Utdelningsadress1string | null

kontaktadress_InternationellAdress_Utdelningsadress2string | null

kontaktadress_InternationellAdress_Utdelningsadress3string | null

kontaktadress_InternationellAdress_Landstring | 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_hitsTypesensePersonDocumentGroupedHits

Show child attributes

group_keystring[] | null

hitsTypesensePersonDocumentHit[] | null

Show child attributes

documentTypesensePersonDocument

Show child attributes

idstring | null

personIdinteger

format: int32

personalIdentityNumberstring | null

allIdentitiesstring[] | null

birthdaystring | null

isProtectedboolean

isCoordinationNumberboolean | null

givenNamestring | null

firstNamestring | null

middleNamestring | null

lastNamestring | null

fullNamestring | null

sexstring

One of: male female

sparRecord

Nested structure omitted at this depth.

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

curl -X POST "https://lens-api.tic.io/search-public/persons" \ -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 } ] }