Get notification details

Overview

Get the full raw record of a single error notification. If it belongs to the caller's company and is still unread, mark it as notified.

Prerequisites

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

Base URL

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

Endpoint

GET /api/v1/partner/error-notifications/details

Authentication

  • Requires a bearer token in the Authorization: Bearer <bearer-token> header.
  • Who can call it: Partner tokens.
  • Authentication is under the partner prefix.
  • notification_id must be the id of an existing notification.
  • The endpoint marks the record as notified only when it belongs to your own company; otherwise it comes back unchanged.

Rate limit

  • No rate limit.

Query parameters

  • Query: notification_id (integer, required) — must be a known notification.

Response

  • data.status (string) — literal success.
  • data.data (object) — the EmailNotification row. Fields include id, company_id, store_id, review_site_id, type, recipients, subject, content, grouped_ids, resolved (bool), resolved_at, notified (bool), notified_at, status, created_at, updated_at, plus appended account_id (int|null, from brand_id). brand_id is not included in the response.

200 Success · 200

{
  "data": {
    "status": "success",
    "data": { "id": 1215, "subject": "Google scrape failed", "notified": true, "company_id": 42 }
  }
}

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/details?notification_id=123" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'

Did this page help you?