List Entities

List entities for the current app, paginated by id.

cursor is typed as uuid.UUID so FastAPI rejects malformed values with 422 before they reach the query layer (was 500 when parsing was deferred to uuid.UUID(cursor) inside the query helper).

GET /entities

List Entities

cURL

curl --request GET \
  --url https://api.hyperspell.com/entities \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "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>"
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

APIKeyAsUser

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.

Query Parameters

type · string | null

search · string | null

limit · integer · default: 100

Required range: 1 <= x <= 500

cursor · string<uuid> | null

Response

200

application/json

Successful Response

items · EntityResponse · object[] · required

Show child attributes

next_cursor · string | null