Search persons

POST

/api/persons/search

Full-text search across Swiss persons. Returns a paginated list of result rows.

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Body Params application/jsonRequired

Example

{
    "query": "Hans Müller",
    "limit": 20,
    "offset": 0
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/persons/search' \
--header 'X-API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "query": "Hans Müller",
    "limit": 20,
    "offset": 0
}'

Responses

🟢200

application/json

Paginated persons.

Body

Example

{
    "success": true,
    "data": {
        "total": 0,
        "items": [
            {
                "id": 9876,
                "name": "Hans Müller",
                "firstname": "Hans",
                "middlename": "string",
                "lastname": "Müller",
                "nationally": "CH",
                "gender": "M",
                "born_city": "string",
                "residence": "Zürich",
                "type": 0,
                "unparsed": "string",
                "slug": "string",
                "status": "string"
            }
        ]
    }
}

🟠400BadRequest

🟠401Unauthorized

🟠402PaymentRequired

🟠429TooManyRequests

🔴502UpstreamError

Modified at 2026-05-01 06:16:37

Get detailed company report

Get person by ID