User Event entity
Read dealership activity events with actor users, message JSON, integration type, and referenced entity IDs.
#Endpoints
User events are dealership activity records created by dashboard actions and system workflows.
GET/v1/user-events
GET/v1/user-events/{id}
x-api-key header.#Filters and Limits
List endpoints share the same pagination envelope. Query booleans use true or false.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | No | Number of records to return. Defaults to 100. Maximum is 500. |
| offset | number | No | Number of records to skip. Defaults to 0. |
| search | string | No | Optional text search. Searchable fields are listed on each entity. |
| createdAfter | datetime | No | Return records created at or after an ISO 8601 timestamp. |
| createdBefore | datetime | No | Return records created at or before an ISO 8601 timestamp. |
| updatedAfter | datetime | No | Return records updated at or after an ISO 8601 timestamp. |
| updatedBefore | datetime | No | Return records updated at or before an ISO 8601 timestamp. |
| type | UserEventType | No | Filter by user event type. |
| userId | uuid | No | Filter by actor user ID. |
| entityId | uuid | No | Filter by supported referenced entity ID. |
type, userId, and entityId.JSON
{
"data": [],
"pagination": {
"limit": 100,
"offset": 0,
"total": 0
}
}#Response
| Field | Type | Nullable | Notes |
|---|---|---|---|
| id | uuid | No | User event ID. |
| type | UserEventType | No | Event type. |
| message | json | No | Rich-text message JSON. |
| user | User | No | Actor user. |
| user2 | User | Yes | Secondary user when present. |
| integrationType | string | Yes | Integration type when relevant. |
| references | object | No | Referenced entity IDs by relationship name. |
| createdAt | datetime | No | Creation timestamp. |
| updatedAt | datetime | No | Last update timestamp. |
#Example Request
Shell
curl "https://api.driverseat.io/v1/user-events?type=PAGE_UPDATED&limit=25" \
-H "x-api-key: sk-driverseat-..."