Skip to main content
GET
/
api
/
v1
/
alerts
List alerts
curl --request GET \
  --url https://shelfforce.ai/api/v1/alerts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "cursor": "<string>",
    "hasMore": true
  }
}

Authorizations

​
Authorization
string
header
required

API key with sf_live_ prefix. Pass as Authorization: Bearer sf_live_...

Query Parameters

​
type
string

Filter by alert type (e.g. price_change, product_review)

​
severity
enum<string>

Filter by severity

Available options:
critical,
warning,
info
​
status
enum<string>

Filter by status

Available options:
unread,
read,
acknowledged,
dismissed,
snoozed
​
cursor
string

Pagination cursor

​
limit
integer
default:50

Max results

Required range: x <= 100

Response

Paginated list of alerts.

​
data
object[]
​
pagination
object

Cursor-based pagination metadata.