List entities

GET /v1/default/banks/{bank_id}/entities

List all entities (people, organizations, etc.) known by the bank, ordered by mention count. Supports pagination.

Authentication required — include an Authorization: Bearer hsk_... header. See Authentication for details.

Path Parameters

Name	Type	Required	Description
bank_id	string	Yes

Query Parameters

Name	Type	Required	Description
limit	integer	No	Maximum number of entities to return
offset	integer	No	Offset for pagination

Example Request

curl -X GET 'https://api.hindsight.vectorize.io/v1/default/banks/your-bank-id/entities' \
  -H 'Authorization: Bearer hsk_your_api_key'

Responses

200 — Successful Response

{
  "items": [
    {
      "canonical_name": "John",
      "first_seen": "2024-01-15T10:30:00Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "last_seen": "2024-02-01T14:00:00Z",
      "mention_count": 15
    }
  ],
  "limit": 100,
  "offset": 0,
  "total": 150
}

422 — Validation Error

{
  "detail": [
    {
      "loc": [
        null
      ],
      "msg": "Message",
      "type": "Error Type",
      "input": null,
      "ctx": {},
      "url": "URL"
    }
  ]
}

---

Source: /v1/default/banks/{bank_id}/entities