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
| Environment | URL |
|---|---|
| Production | https://production-api.shoutaboutus.com |
| Development | https://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
partnerprefix. - Scoped by the caller's own company: a partner only sees notifications under their company.
- The
typequery param maps to the SQL filter (resolved=1for resolved,status='acknowledged'for acknowledged, else open).
Rate limit
- No rate limit.
Query parameters
- Query:
type(string, required) — one ofopen,acknowledged,resolved. - Query:
limit(integer, optional) — page size, default 5. - Query:
page(integer, optional) — page number, default 1. - Query:
sort_field(string, optional) — one ofnotificationDate,latest_note_date,accountName,storeName,reviewSiteName,subject,resolved. DefaultnotificationDate. (Not in the request validation rules; read from input directly.) - Query:
sort_by(string, optional) —asc/desc/ASC/DESC. Defaultdesc. - Query:
search_field(string, optional) — one ofnotificationDate,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) —Yeswhen unread (notified != 1), elseNo.notificationDate(string) — created_at formattedm/d/y.accountName(string|null) — account company name (com.name).storeName(string) —CONCAT_WS(' - ', store.name, store.storeid).reviewSiteName(string) — review site name;Maps.Googlenormalized toGoogle;#N/Awhen 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 formattedm/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'sid.review_site_id(int|null) — the review site'sid.store_review_site_id(int|null) — matching the connected review site'sidfor the store+site, or null.show_connect_button(string) —yes/no(yes whenreview_site_id > 0and not resolved).
200 Success · 200
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
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
422 | The request failed validation — the response names the fields |
500 | Unexpected 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'Updated 8 days ago
Did this page help you?
