# Search endpoints

Search a workspace's people, records and places, as the app's search box.

Paths are relative to https://kleiobase.com/api/v1. Request and response schemas are in the OpenAPI document at https://kleiobase.com/api/v1/openapi.json.

## Search

`GET /workspaces/{workspace_id}/search`

People by name, birth place or birth date; records by title, file name, type, event place or date, or a matched person; places on records. Up to 5 people, 5 records and 3 places.

Parameters:

- `workspace_id` (path, required): The workspace (project) id.
- `q` (query, optional): 1 to 200 characters. Names match ignoring case, accents and punctuation.

Responses:

- `200`: Results.
- `401`: Missing, malformed, unknown or revoked API key.
- `403`: The account has no paid plan.
- `404`: The workspace does not exist or is not visible to this key's owner.
- `422`: q is missing or longer than 200 characters.
- `429`: Rate limit exceeded. Wait the number of seconds in Retry-After.
- `500`: Unexpected error. Retry later and quote request_id if it persists.

Canonical: https://kleiobase.com/developers/docs/reference/search
