entities

Get Entity

Changed on

Fetch a single entity belonging to the current app.

Returns 404 when the entity does not exist or is not visible to the app.

get/entities/{entity_id}

Request

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

Path parameters

entity_idstring uuid required

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

idstring uuid required
typestring required
namestring required
descriptionstring nullable
attributesobject
status'provisional' | 'confirmed'

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

supporting_document_countinteger nullable
supporting_scope_countinteger nullable
record_countinteger nullable
hard_linked_mention_countinteger nullable
prominence_calculated_atstring date-time nullable
prominence_versionstring nullable
discovery_rankinteger nullable
created_atstring date-time nullable
updated_atstring date-time nullable

Changes