Persons

Search persons by name

Searches for natural persons by name (first name, last name, or both). Returns a deduplicated list of matching persons with their person_id key and the number of companies they are linked to.

Use the returned person_id with GET /persons/{personId}/connections to fetch full connection details.

Identification is restricted to name-based queries (first name, last name, or both). Protected data, including PESEL and exact birth dates, is never exposed. To assist with identification, every result includes a birth_year (integer).

Result capping: internally the search scans up to 2 000 matching link rows before aggregation. For very common names the response may include a note field indicating the result set was truncated; use a more specific query to narrow results.

get/persons/search

Request

  • Base URL: https://compabase.com/api/v1
  • URL: https://compabase.com/api/v1/persons/search
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Query parameters

qstring required

Name substring to search for (case-insensitive). Must be at least 2 characters. Matched against the stored display name using ILIKE %q%.

limitinteger

Maximum number of persons to return. Capped at 50.

Response

List of matching persons.

totalinteger required

Number of distinct persons found (before limit slicing).

notestring nullable

Present when the internal scan limit was reached and results may be incomplete.

Example response

{
  "data": [
    {
      "birth_year": 1985
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.