Endpoint Reference

External Notifications API

Use this endpoint to fetch sent notifications for a single location by combining that location's UUID-style location ID with an active private API key created for the same location.

Method: GET Route: /api/notifications Auth: location ID + API key

Authentication

Every request must include both a location ID and an active API key. This information can be obtained from the API Access screen.

Recommended headers

x-location-id: your-location-uuid
x-api-key: your-active-api-key
Accept: application/json

Also supported:

  • Query string: locationID, APIKEY
  • Alternate headers: location-id, api-key
  • Authorization: Bearer <api key>
API Access must be enabled through your license, and both the location and API key must be active before requests will be accepted.

Endpoint

The endpoint to call for "Get Notifications"

GET

Optional query parameters

Name Type Notes
startDate string MM/DD/YYYY
defaults to current date
endDate string MM/DD/YYYY
defaults to current date
limit integer Defaults to 100
maximum is 1000
offset integer Defaults to 0

Live API Request

Enter the request values below to call the live notifications endpoint directly from this page and inspect the JSON response.

Sent to the API as MM/DD/YYYY.
Sent to the API as MM/DD/YYYY.
Waiting for request

API Response

{
  "message": "Response will appear here after you send the request."
}

Successful response

The response echoes the applied startDate and endDate so the effective query window is visible even when defaults are used.

{
  "success": true,
  "locationID": "abc123uuid",
  "locationName": "Main Campus",
  "startDate": "03/01/2026",
  "endDate": "03/12/2026",
  "numberOfRecordsInQuery": 5,
  "totalRecords": 5,
  "startOffset": 1,
  "numRecordsReturned": 2,
  "numberOfPagesRemaining": 1,
  "limit": 2,
  "data": [
    {
      "id": 101,
      "title": "Test One",
      "message": "Body 1",
      "created_at": "2026-03-12T10:00:00.000Z",
      "target_audience": "all",
      "target_param": null,
      "priority": "normal",
      "delivery_channels": ["pager"],
      "recipient_source_type": "team",
      "recipient_source_ref": "ER",
      "sender_id": 3,
      "sender_name": "Alice Admin",
      "recipient_count": 4
    }
  ]
}

Common errors

Status Example
400 locationID and APIKEY are required.
400 startDate must be a valid date.
401 Invalid locationID or APIKEY.
403 This location is inactive.
403 The API key is inactive.
403 API access is disabled because this location does not currently have an active API access entitlement.
500 Server error

Postman setup

  1. Create a new HTTP request in Postman.
  2. Set the method to GET.
  3. Use as the URL.
  4. Add headers for x-location-id, x-api-key, and optionally Accept: application/json.
  5. Add optional params like startDate, endDate, limit, and offset only when needed.

Starter example

GET /api/notifications?startDate=03/01/2026&endDate=03/12/2026&limit=100&offset=0
Coming Soon

Future API Call

This placeholder is ready for the next API endpoint you add. Once the route exists, its full documentation can be dropped into this panel and it will become selectable from the left column.

Status: Not documented yet
Recommended structure

Add the method and route, authentication rules, request parameters, success payload, error responses, and Postman examples here when the next API call is ready.

How to expand this page

Create another button in the left navigation, assign it a matching data-doc-target value, then add a right-side panel with the same data-doc-panel value. The page switcher will handle the rest automatically.