Entries

Get an entry, at its page’s address

The entry as data, at its page’s address plus .json: the same body as GET /api/v1/entities/{vhid}. An old name or a merged entry’s key answers with the entry it now leads to, without a redirect; url is that entry’s canonical page, and its own .json is that plus .json. A key nothing answers to is a JSON 404 and is never redirected to a guess, as the page would be.

Same-origin only: it sends no CORS headers (use /api/v1 from a browser on another site). A key is not needed. One that is sent is checked: a bad one is refused (400 or 401) before the route runs, and a good one makes the answer private (Cache-Control: no-store, Vary: Authorization).

get/{key}.json

Request

  • Base URL: https://verifiedhandles.org
  • URL: https://verifiedhandles.org/{key}.json
  • Auth: one of:
    • none
    • HTTP bearer

Path parameters

keystring required

The entry’s VHID (11 digits), its short name, or one of its old names. Short names are matched exactly. Written before .json, so /james.json or /53500361835.json.

Response

The entry.

vhidstring required

The entry’s VHID: 11 digits, permanent.

shortstring nullable required

The entry’s short name (/<short>), if it has one.

titlestring required
subtitlestring nullable required
entity_typestring nullable required

What it is, from its Wikidata item: person, organization or brand; null when unknown. entity_kind says more.

entity_kind'person' | 'musical_group' | 'sports_organization' | 'broadcaster' | 'publisher' | 'educational_institution' | 'research_organization' | 'religious_organization' | 'museum' | 'financial_institution' | 'chain' | 'nonprofit' | 'company' | 'organization' | 'show' | 'website' | 'software' | 'brand' nullable required

The finer kind of thing it is, from its Wikidata item’s classes; null when unknown (an organisation or a brand not yet read since kinds were added reads null until the sync next reads its item). Each kind belongs to one entity_type, and person, organization and brand are also the kinds of an entry of that type with no finer one. The kinds, with their type: person (person: person), musical_group (organization: musical group), sports_organization (organization: sports organisation), broadcaster (organization: broadcaster), publisher (organization: publisher), educational_institution (organization: educational institution), research_organization (organization: research organisation), religious_organization (organization: religious organisation), museum (organization: museum), financial_institution (organization: financial institution), chain (organization: retail or hospitality chain), nonprofit (organization: charity or non-profit), company (organization: company), organization (organization: organisation), show (brand: show), website (brand: website or app), software (brand: software), brand (brand: brand). New kinds may be added; treat an unknown value as its entity_type.

verifiedboolean required

Verified Handles has verified the entry.

descriptionstring nullable required

The description as sanitised HTML, links to other entries named as they are today.

description_license'CC-BY-SA-4.0' nullable required

The description’s licence, as an SPDX id: CC-BY-SA-4.0 when it was taken from Wikipedia (description_source is set), which means crediting the article and sharing alike. Null otherwise: the description is CC0 like the rest of the text.

urlstring required

The entry’s canonical page.

imagestring nullable required

The lead image (the same as images[0].url), or null.

Changes

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