Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

events

List events

get/app/v1/events

Query parameters

namestring

Event name

descriptionstring

Event description

status'open' | 'resolved' | 'overdue' | 'dismissed'

Event status

classification'planned' | 'unplanned'

Event classification

start_windowstring date-time

Returns all events that were ongoing during the start/end (in UTC)

end_windowstring date-time

Returns all events that were ongoing during the start/end (in UTC)

sort_bystring

sort by

sort_direction'asc' | 'desc'

sort direction

Response

A successful operation

page_numbernumber
page_sizenumber
total_entriesnumber
total_pagesnumber

Example response

{
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "associated_facility": {
        "custom_attributes": {
          "attribute1": 12345,
          "attribute2": "value1"
        },
        "latitude": 51,
        "longitude": -114
      },
      "duration": "10 days 12 hours"
    }
  ]
}