---
title: "Find an entry to link to"
method: GET
path: "/api/entity/search"
tags: ["Proposing changes"]
---

# Find an entry to link to

`GET /api/entity/search`

## Request

- Base URL: `https://verifiedhandles.org`
- URL: `https://verifiedhandles.org/api/entity/search`
- Auth: HTTP bearer

The editor’s link search: up to 8 entries by name, words or QID, for a link in a description. Unlike the public search it is never cached, so an entry made a moment ago is found. A word the site does not search for answers an empty list.

## Query parameters

- `q` string, required

## Response `200`

The best matches first.

- LinkSearch: Entries to link to.
  - `results` object[], required
    - `vhid` string, required
    - `title` string, required
    - `subtitle` string, nullable, required
    - `short` string, nullable, required

## Other responses

- `400`: Or the request sent a key and a session cookie together (`bearer_with_cookie`): send one.
- `401`: No key was sent (`auth_required`), or the key was refused: unknown, revoked or expired, its holder may no longer use keys, or this instance takes none. Carries `WWW-Authenticate: Bearer`. After 60 refused keys from one IP address in a minute, every key from there is answered `429` (text, with `Retry-After`) until the minute is up.
- `403`: A read-only key tried to change something (`read_only_key`), or the account is blocked (`forbidden`).
- `429`: Too many changes in the last minute: counted per IP address, per account and per key (an admin key’s per key alone, at the limit set on Console → Rate limits). Wait the number of seconds `Retry-After` gives.
- `503`: The site is down for maintenance. The body is the maintenance page, as HTML. Try again later: `Retry-After` gives the seconds.

---

[API](https://skmtc.dev/verifiedhandles/apis/verified-handles-api.md) · [All operations](https://skmtc.dev/verifiedhandles/apis/verified-handles-api/llms.txt) · [OpenAPI document](https://skmtc.dev/verifiedhandles/apis/verified-handles-api/revisions/40720de2e0ec?raw)