API guide
Alerts API
Alerts API 用于获取和处理职业健康提醒与风险信号。
Path: /api/v1/alerts
Format: AI-first docs
信息
Contract-backed page
这一页直接从当前 OpenAPI 契约生成摘要，用来保证文档路径和正式接口保持一致。
GET /api/v1/alerts
List career alerts
Required scopes
read:alerts
Request
- includeRead (query): Include read alerts (default false)
- includeDismissed (query): Include dismissed alerts (default false)
Responses
- 200: OK
- 401:
- 403:
- 429:
- 500:
Errors
none documented
Examples
Code sample (curl)
1
curl "https://api.profileclaw.com/api/v1/alerts?includeRead=true" -H "Authorization: Bearer $PROFILECLAW_API_KEY"Code sample (curl)
1
curl "https://api.profileclaw.com/api/v1/alerts?includeRead=true&includeDismissed=false" -H "Authorization: Bearer $PROFILECLAW_API_KEY"PATCH /api/v1/alerts
Mark an alert as read or dismissed
Required scopes
write:alerts
Request
- id (query): Alert ID
Responses
- 200: OK
- 400: Bad request
- 401:
- 403:
- 404: Not found
- 429:
- 500:
Errors
alerts.missing_idalerts.invalid_actionalerts.not_found
Examples
Code sample (curl)
1
curl -X PATCH "https://api.profileclaw.com/api/v1/alerts?id=alert_123" -H "Authorization: Bearer $PROFILECLAW_API_KEY" -H "Content-Type: application/json" -d '{"action":"read"}'Related surfaces
Use these surfaces when you need deeper inspection or automation.