---
title: "Simple entity search"
method: GET
path: "/search/{dataset}"
tags: ["Matching"]
---

# Simple entity search

`GET /search/{dataset}`

Search endpoint for matching entities based on a simple piece of text, e.g.
a name. This can be used to implement a simple, user-facing search. For proper
entity matching, the multi-property matching API should be used instead.

Search queries can include field-specific fitlers, wildcards and fuzzy searches.
See also: [search API documentation](https://www.opensanctions.org/docs/api/search/).

## Path parameters

- `dataset` string, required — Data source or collection name to scope the query to.

## Query parameters

- `q` string
- `schema` string
- `include_dataset` string[] — Limit the results to entities that are part of at least one of the given datasets.
- `exclude_dataset` string[]
- `exclude_schema` string[]
- `changed_since` string, nullable
- `countries` string[]
- `topics` string[]
- `datasets` string[]
- `filter` string[] — Use the syntax `field:value` to filter on a specific field. Properties are indexed as fields named `properties.birthDate:1985`.
- `limit` integer
- `offset` integer
- `sort` string[]
- `target` boolean, nullable — Please specify a list of topics of concern, instead.
- `fuzzy` boolean
- `simple` boolean
- `facets` Facet[]
- `filter_op` 'AND' | 'OR'

## Response `200`

Successful Response

- SearchResponse
  - `limit` integer, required
  - `offset` integer
  - `total` TotalSpec, required
    - `value` integer, required
    - `relation` string
  - `results` EntityResponse[], required
    - `id` string, required
    - `caption` string, required
    - `schema` string, required
    - `properties` object, required
    - `datasets` string[]
    - `referents` string[]
    - `target` boolean
    - `first_seen` string
    - `last_seen` string
    - `last_change` string
  - `facets` object, required

## Other responses

- `400` — Invalid query
- `422` — Validation Error
- `500` — Server error

---

[API](https://skmtc.net/opensanctions/apis/opensanctions-api.md) · [All operations](https://skmtc.net/opensanctions/apis/opensanctions-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/opensanctions/opensanctions-api/revisions/8261f1aa0d2c/schema)