Skip to content
Lexoh API

Events API

OpenAPI JSON

Query operational history

Use /v1/event for one record and /v1/event/list for filtered history. Both operations use POST with JSON.

POST /v1/event/list

List operational events

Required permissions

  • can_view_events

Authentication, MFA and resource-scope restrictions still apply.

Requires can_view_events. Send the filters in the JSON body. The response contains success, events and count; non-empty results also include next_cursor.

JSON request body

ParameterTypeDescription
pageintegerPage number; default 1.
page_limitintegerResults per page; default 25.
searchstringOptional search text.
cursor_idinteger0 starts at the newest records; next_cursor retrieves older records.
device_idsarray<integer>Filter by device identifiers.
types / event_typesarray<integer>Numeric event-type and entity-type filters.
start_date / end_datestringOptional date filters.

Request Example

curl -X POST "https://your-lexoh-server.app.lexoh.com:3000/v1/event/list" \
  -H "SessionID: SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"cursor_id":0,"page_limit":25}'

Response Example

Example with no matching events.

{
  "success": true,
  "events": [],
  "count": 0
}

Read event fields

  • id and device_id are numeric identifiers.
  • type, category and subcategory are numeric classifications.
  • name, description and date_at describe the recorded event.
  • data is a string field; do not assume it is already a parsed JSON object.

POST /v1/event

Retrieve one event

Required permissions

  • can_view_events

Authentication, MFA and resource-scope restrictions still apply.

Send the event id in the JSON body. The same event-viewing permission applies.

Request Example

curl -X POST "https://your-lexoh-server.app.lexoh.com:3000/v1/event" \
  -H "SessionID: SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id":123}'

Paginate without confusing old and new records

Results are ordered by descending event id. Use next_cursor as cursor_id to continue into older records with the same filters. To check for newer activity, start again with cursor_id:0 and deduplicate records by id.

Connect event history to your application

Review the available event integration workflow.

Event integrations →
Call Lexoh 1-888-401-8019