LIlight
v1 - Activity Events

List company activity events

Returns a paginated list of company activity events across supported record types, newest first by default. Use sort=createdAt:asc for oldest first or sort=createdAt:desc for newest first. Keep the same sort and filters when following a cursor. Requires COMPANY_ADMIN or AUDITOR with access to every entity. Supports filtering by record, action, actor, correlation ID and time.

get/v1/activity-events

Request

  • Base URL
    https://light.inc (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Query parameters

filterstring

Filter string in the format field:operator:value. To provide multiple filters, separate them with commas.

Available operators: eq, ne, in, not_in, gt, gte, lt, lte.

  • For in and not_in operators, provide multiple values separated by the pipe character (|).

Available fields: action, actorId, correlationId, createdAt, entityId, entityType.

Example:state:in:IN_DRAFT|SCHEDULED|PAID,amount:gte:500,vendorId:ne:null
limitinteger

Maximum number of items to return. Default is 50, maximum is 200.

cursorstring

The cursor position to start returning results from. Omit it, or provide 0, for the initial request. For subsequent requests, use nextCursor from the previous response to navigate. Cursor values are opaque and should not be constructed manually. This endpoint paginates by cursor only and has no offset parameter.

sortstring

Sort string in the format field:direction. To provide multiple sort fields, separate them with commas.

Available directions: asc, desc.

Available fields: createdAt.

Example:amount:desc,createdAt:asc

Response

default response

hasMoreboolean

Boolean flag indicating if there are more records available

nextCursorstring nullable

Cursor for fetching the next page

prevCursorstring nullable

Cursor for fetching the previous page

Changes

No recorded changes to this operation across all 1 revision of this API.