List error notifications

Overview

Get a paginated, sortable, searchable list of the partner's error/monitoring notifications, filtered by lifecycle state (open / acknowledged / resolved).

Prerequisites

  • A bearer token. Callable with Partner tokens.
  • Values for the required query parameter type — see the table below.

Base URL

EnvironmentURL
Productionhttps://production-api.shoutaboutus.com
Developmenthttps://development-api.shoutaboutus.com

Endpoint

GET /api/v1/partner/error-notifications

Authentication

  • Requires a bearer token in the Authorization: Bearer <bearer-token> header.
  • Who can call it: Partner tokens.
  • Authentication is under the partner prefix.
  • Scoped by the caller's own company: a partner only sees notifications under their company.
  • The type query param maps to the SQL filter (resolved=1 for resolved, status='acknowledged' for acknowledged, else open).

Rate limit

  • No rate limit.

Query parameters

  • Query: type (string, required) — one of open, acknowledged, resolved.
  • Query: limit (integer, optional) — page size, default 5.
  • Query: page (integer, optional) — page number, default 1.
  • Query: sort_field (string, optional) — one of notificationDate, latest_note_date, accountName, storeName, reviewSiteName, subject, resolved. Default notificationDate. (Not in the request validation rules; read from input directly.)
  • Query: sort_by (string, optional) — asc/desc/ASC/DESC. Default desc.
  • Query: search_field (string, optional) — one of notificationDate, accountName, storeName, subject, reviewSiteName. (Not in request validation rules; read from input directly.)
  • Query: search_value (string, optional) — value to search for.

Response

  • id (int) — notification id.
  • is_badge (string) — Yes when unread (notified != 1), else No.
  • notificationDate (string) — created_at formatted m/d/y.
  • accountName (string|null) — account company name (com.name).
  • storeName (string) — CONCAT_WS(' - ', store.name, store.storeid).
  • reviewSiteName (string) — review site name; Maps.Google normalized to Google; #N/A when empty.
  • subject (string) — notification subject, or #N/A.
  • isResolved (string) — Yes/No.
  • latestNote (string) — latest note content, or #N/A.
  • lastUpdated (string) — latest note date formatted m/d/y.
  • show_acknowledge_button (string) — yes/no (yes when not acknowledged and not resolved).
  • show_resolved_button (string) — yes/no (yes when not resolved).
  • store_id (int|null) — the location's id.
  • review_site_id (int|null) — the review site's id.
  • store_review_site_id (int|null) — matching the connected review site's id for the store+site, or null.
  • show_connect_button (string) — yes/no (yes when review_site_id > 0 and not resolved).

200 Success · 200

{
  "data": [
    {
      "id": 1215,
      "subject": "Google scrape failed",
      "accountName": "Acme Brand",
      "storeName": "Sydney CBD",
      "reviewSiteName": "Google",
      "notificationDate": "05/29/26",
      "show_acknowledge_button": "yes",
      "show_resolved_button": "yes"
    }
  ]
}

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
422The request failed validation — the response names the fields
500Unexpected server error

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/partner/error-notifications?type=open" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'

Did this page help you?