entities

List Entities

Changed on

List entities available to the current app.

Results can be filtered by type, status, name, and supporting-document count. Use the returned cursor to retrieve the next page.

get/entities

Request

  • Base URL
    https://api.hyperspell.com
  • URL
    https://api.hyperspell.com/entities
  • Auth
    HTTP bearer

Query parameters

typestring nullable
status'provisional' | 'confirmed'

How strongly the entity's current identity has been established.

searchstring nullable
name_prefixstring nullable
min_supporting_documentsinteger nullable
sort_by'id' | 'name' | 'type' | 'prominence' | 'discovery_rank'
sort_dir'asc' | 'desc'
limitinteger
cursorstring nullable

Headers

X-As-Userstring nullable

Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token

Response

Successful Response

next_cursorstring nullable

Changes