Skip to main content
POST
/
v1
/
notifications
/
list
List Notifications
curl --request POST \
  --url https://api.mixpeek.com/v1/notifications/list \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "notification_type": "pipeline_success",
  "priority": "low",
  "read": true,
  "user_id": "<string>"
}
'
{
  "results": [
    {
      "type": "pipeline_success",
      "priority": "low",
      "title": "<string>",
      "content": "<string>",
      "organization_id": "<string>",
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "user_id": "<string>",
      "metadata": {},
      "delivery_status": {},
      "read": false,
      "read_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {},
  "total": 123
}

Headers

​
Authorization
string
required

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Query Parameters

​
limit
integer | null
​
offset
integer | null

Body

application/json

Request model for listing notifications.

​
notification_type
enum<string> | null

Filter by notification type

Available options:
pipeline_success,
pipeline_failure,
feature_extraction_success,
feature_extraction_failure,
system_alert,
billing_alert,
quota_alert,
audit_alert,
maintenance_alert,
custom
​
priority
enum<string> | null

Filter by priority

Available options:
low,
medium,
high,
critical
​
read
boolean | null

Filter by read status

​
user_id
string | null

Filter by user ID

Response

Successful Response

Response model for listing notifications.

​
results
Notification · object[]
required

List of notifications

​
pagination
Pagination · object
required

Pagination information

​
total
integer
required

Total number of notifications