Skip to main content

Entity Viewers API

[API Docs] [SDK]

The Entity Viewers API provides the capability to track user view-actions with entities. It offers endpoints to track when a user has seen an entity, downloaded a file and allows to mark an entity as unseen.

The entity schame must have the entity_viewers capability configured:

"id": "8b2e66ef-5a30-4dcd-8f88-a51af7a54cc6",
"name": "File",
"plural": "Files",
"slug": "file",
"capabilities": [
"name": "entity_viewers",
"title": "Entity Viewers",
"ui_hooks": []

Once the entity_viewers capability is configured, you can start tracking view actions for different entities.

To mark file as downloaded:


To mark the opportunity as seen:


To mark the contract as unseen: