Skip to main content
GET
/
entities
/
{entity_id}
Get Entity
curl --request GET \
  --url https://api.hyperspell.com/entities/{entity_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "<string>",
  "name": "<string>",
  "mention_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "attributes": {},
  "first_seen_resource_id": "<string>",
  "last_seen_resource_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Path Parameters

​
entity_id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required
​
type
string
required
​
name
string
required
​
mention_count
integer
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string | null
​
attributes
Attributes · object
​
first_seen_resource_id
string | null
​
last_seen_resource_id
string | null