List event notifications

GET /api/notifications
Api key

Allows you to retrieve a paginated list of event notifications for the user.

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]

      User notification data

      Hide data attributes Show data attributes object
      • booth_count number

        The number of booths in the event notification

      • created_at string

        ISO8601 encoded string of when the event definition was created.

      • email_sent_at string(time)

        The UTC time at which the notification was sent

      • event_count number

        The number of events in the event notification

      • id string

        ID of the event definition in the system.

      • period_end string

        The time the event notification group ends at

      • period_start string

        The time the event notification group begins at

      • seen_in_app boolean

        Whether the notification has been read in the app

      • updated_at string

        ISO8601 encoded string of when the event was last edited.

      • user_id string

        ID of the user

    • 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/notifications 
curl \
 --request GET 'http://localhost:4000/api/notifications' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "data": [
    {
      "id": "f260f115-f2e6-4dde-bcab-98b10fdb8cf6",
      "user_id": "002d3656-34c1-446c-a987-65ec766f76a4",
      "created_at": "2025-07-30 13:00:00Z",
      "period_end": "2025-07-30 13:00:00",
      "updated_at": "2025-07-30 13:00:00Z",
      "booth_count": 5,
      "event_count": 3,
      "seen_in_app": true,
      "period_start": "2025-07-29 13:00:00",
      "email_sent_at": "2025-07-30 13:00:00Z"
    }
  ],
  "page": 1,
  "limit": 1,
  "pages": 20,
  "total": 20
}
Response examples (200) 
{
  "data": [
    {
      "id": "f260f115-f2e6-4dde-bcab-98b10fdb8cf6",
      "user_id": "002d3656-34c1-446c-a987-65ec766f76a4",
      "created_at": "2025-07-30 13:00:00Z",
      "period_end": "2025-07-30 13:00:00",
      "updated_at": "2025-07-30 13:00:00Z",
      "booth_count": 5,
      "event_count": 3,
      "seen_in_app": true,
      "period_start": "2025-07-29 13:00:00",
      "email_sent_at": "2025-07-30 13:00:00Z"
    }
  ],
  "page": 1,
  "limit": 1,
  "pages": 20,
  "total": 20
}
Response examples (401) 
{
  "error": "Error Reason"
}
Response examples (401) 
{
  "error": "Error Reason"
}