Events

List Events

get

List of events

Query parameters
seedstring · uuidOptional

Filter events by seed ID

intelstring · uuidOptional

Filter events by intel ID

statusstringOptional

Filter events by status

priorityinteger · min: 1 · max: 5Optional

Filter events by priority

typestringOptional

Filter events by type

interactionstringOptional

Filter events by interaction type

searchstringOptional

Text search for a particular event

offsetintegerOptional

Pagination offset

limitinteger · min: 1 · max: 100Optional

Pagination limit

orderBystringOptional

Order the results by this field, in this direction

Example: createdAt:descPattern: ^[a-zA-Z0-9\_]+(:(asc|desc))?$
Responses
chevron-right
200

OK

application/json
get
/events
200

OK

Get Event

get

Get details for a particular event

Path parameters
eventIdstring · uuidRequired
Responses
chevron-right
200

OK

application/json

Event model response

idstring · uuidRead-onlyOptional
titlestringRead-onlyOptional

The event title

typestring · enumRead-onlyOptional

The event type

Possible values:
interactionstringRead-onlyOptional
prioritynumber · max: 5Read-onlyOptional

The event priority

statusstring · enumRead-onlyOptional

The event status

Possible values:
roleIdstringRead-onlyOptional

The event seed ID

createdAtstring · date-timeRead-onlyOptional
updatedAtstring · date-timeRead-onlyOptional
sourcestringRead-onlyOptional
targetstringRead-onlyOptional
detailsstringRead-onlyOptional
destinationstringRead-onlyOptional
timestampnumberRead-onlyOptional
seedIdstring · uuidRead-onlyOptional
testbooleanRead-onlyOptional
whitelistedbooleanRead-onlyOptional
get
/events/{eventId}
200

OK