List notification event definitions

GET /api/event_definitions
Api key

Allows you to retrieve a paginated list of notification event definitions under your account.

Query parameters

  • filter string

    criteria to filter by

  • sort string

    criteria to sort by

  • limit string

    amount of results per page to return

  • page string

    page number

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • data array[object]

      Event definitions data

      Hide data attributes Show data attributes object
      • account_id string

        ID of the account the event definition belongs to.

      • booth_ids array[string]

        IDs of the booths for which to evaluate the event.

      • category string

        Category the event falls under.

      • created_at string

        ISO8601 encoded string of when the event definition was created.

      • created_by string

        ID of the user who created the event definition.

      • description string

        Short description of the event.

      • evaluation_period string

        Whether the event is evaluated daily or weekly.

      • event_type string

        Whether the event is a tag or aggregate type of event.

      • id string

        ID of the event definition in the system.

      • last_edited_by string

        ID of the user who last modified the event definition.

      • min_duration integer

        Minimum duration to consider an ocurrence of the event.

      • name string

        Name of the event definition.

      • rules array[object]

        Rules that make up the event definition.

        Hide rules attributes Show rules attributes object
        • op string

          Operation to use when evaluating. '==', '!=', '<', '<=', '>', '>=', 'in', 'not_in', 'like'

        • tag string

          Name of the tag on which to evaluate a condition.

        • value

          Value to compare against

      • updated_at string

        ISO8601 encoded string of when the event was last edited.

    • limit number

      The number of items per page currently applied

    • page number

      The number of the page returned

    • pages number

      The total number of pages matching the current search

    • total number

      The total number of regions matching the query
  • 401 application/json

    Unauthorized

    Hide response attribute Show response attribute object
    • error string

      Human readable version of the error status code
GET /api/event_definitions 
curl \
 --request GET 'http://localhost:4000/api/event_definitions' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "data": [
    {
      "id": "f260f115-f2e6-4dde-bcab-98b10fdb8cf6",
      "name": "Doors open during bake mode",
      "rules": [
        {
          "op": "like",
          "tag": "BoothMode",
          "value": "Bake%"
        },
        {
          "op": "==",
          "tag": "I_xDoorClosed",
          "value": false
        }
      ],
      "category": "Safety & Regulatory",
      "booth_ids": [
        "a920bc22-de00-1983-bbca-90201849fbac",
        "29302931-fabe-aaac-910a-119301b8ac91"
      ],
      "account_id": "a9299bca-acc2-4dde-1111-83a08ca12128",
      "created_at": "2025-07-30 13:00:00Z",
      "created_by": "371a9242-02da-433d-a25a-b5031d5f3b46",
      "event_type": "tag",
      "updated_at": "2025-07-30 13:00:00Z",
      "description": "Event definition to check if doors were opened while the booth was in bake mode",
      "min_duration": 2,
      "last_edited_by": "371a9242-02da-433d-a25a-b5031d5f3b46",
      "evaluation_period": "daily"
    }
  ],
  "page": 1,
  "limit": 1,
  "pages": 20,
  "total": 20
}
Response examples (200) 
{
  "data": [
    {
      "id": "f260f115-f2e6-4dde-bcab-98b10fdb8cf6",
      "name": "Doors open during bake mode",
      "rules": [
        {
          "op": "like",
          "tag": "BoothMode",
          "value": "Bake%"
        },
        {
          "op": "==",
          "tag": "I_xDoorClosed",
          "value": false
        }
      ],
      "category": "Safety & Regulatory",
      "booth_ids": [
        "a920bc22-de00-1983-bbca-90201849fbac",
        "29302931-fabe-aaac-910a-119301b8ac91"
      ],
      "account_id": "a9299bca-acc2-4dde-1111-83a08ca12128",
      "created_at": "2025-07-30 13:00:00Z",
      "created_by": "371a9242-02da-433d-a25a-b5031d5f3b46",
      "event_type": "tag",
      "updated_at": "2025-07-30 13:00:00Z",
      "description": "Event definition to check if doors were opened while the booth was in bake mode",
      "min_duration": 2,
      "last_edited_by": "371a9242-02da-433d-a25a-b5031d5f3b46",
      "evaluation_period": "daily"
    }
  ],
  "page": 1,
  "limit": 1,
  "pages": 20,
  "total": 20
}
Response examples (401) 
{
  "error": "Error Reason"
}
Response examples (401) 
{
  "error": "Error Reason"
}