Has events by entity
API Reference
Has events by entity
Fast boolean check whether an entity has any linked user events β same linkage scope as list-by-entity without returning event rows or counts.
GET
Has events by entity
Overview
Use this endpoint when you only need to know if an entity has user events (for UI badges, tab visibility, or preflight checks), not the full timeline. It uses the same matching scope as List by Entity:entity_id, entity_external_id, or tax_id within your organization.
Entity identifiers: you can query by query parameter without the internal UUID. Lookup priority:
entity_id β entity_external_id β tax_id (when multiple are sent, the highest-priority wins). For tax_id, the DB comparison normalizes non-alphanumeric characters (e.g. 20-24245549-6 and 20242455496).The legacy route GET β¦/entity/{entityId}/has-events remains available when you already have the UUID.Performance
Designed for low latency:| Aspect | Behavior |
|---|---|
| Queries | Two round trips: entity lookup + one LIMIT 1 probe on user_events |
| No | COUNT(*), ORDER BY, pagination, or full event / metadata columns in the response |
| Indexes | organization_id + entity_id uses idx_user_events_organization_entity_id; entity_external_id and tax_id use dedicated indexes when the OR branch matches those identifiers |
Endpoint
Authentication
Requires a valid API key in the Authorization header:Query Parameters
At least one is required. If you send multiple, priority isentity_id β entity_external_id β tax_id.
Entity UUID (highest priority)Example:
?entity_id=550e8400-e29b-41d4-a716-446655440000Your external entity identifierExample:
?entity_external_id=user_12345Tax ID (CUIT/CUIL/CPF/CNPJ, etc.). Exact and normalized match (alphanumeric only)Example:
?tax_id=20242455496Response
Indicates if the request was successful
true if at least one user event is linked to this entity (same scope as list-by-entity); otherwise falseResolved internal entity UUID (useful when you queried by
entity_external_id or tax_id)Example β has events
Example β no events
Errors
| Status | Code | When |
|---|---|---|
| 400 | β | No entity identifier provided in query |
| 404 | ENTITY_NOT_FOUND | Entity does not exist in your organization or is soft-deleted |
| 401 | β | Missing or invalid API key |
| 403 | β | Insufficient permissions (events:read) |
Examples
Next Steps
List by Entity
Full event timeline when
hasEvents is trueList Events
Query events with filters
Event Statistics
Aggregated counts by event type
Events Overview
User events API overview