Notifications
List notifications
Retrieve a paginated list of all notifications in your project.
A notification represents a message sent to a single recipient through a notiflow run. Each notification can have multiple deliveries (one per channel).
Authorization
ApiKeyAuth SecretKeyAuth x-notiflows-api-key<token>
Your project's public API key. Found in Project Settings. Starts with pk_.
In: header
x-notiflows-secret-key<token>
Your project's secret key. Found in Project Settings. Starts with sk_. Keep this secret!
In: header
Query Parameters
after?string
Cursor for fetching the next page
before?string
Cursor for fetching the previous page
limit?integer
Number of items per page (default: 25, max: 1000)
status?string
Filter by status
topic?string
Filter by topic
created_after?string
Filter by created after (ISO 8601 datetime)
created_before?string
Filter by created before (ISO 8601 datetime)
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.notiflows.com/admin/notifications?status=processed&topic=order-updates"{
"items": [
{
"actor": {
"avatar": "https://example.com/avatars/jane.jpg",
"created_at": "2024-01-15T10:30:00Z",
"custom_fields": {
"company": "Acme Inc",
"plan": "premium"
},
"email": "jane.doe@example.com",
"external_id": "user_12345",
"first_name": "Jane",
"id": "01HQXYZ123456789ABCDEFGHIJ",
"last_name": "Doe",
"locale": "en-US",
"phone": "+15551234567",
"timezone": "America/New_York",
"updated_at": "2024-01-20T14:45:00Z"
},
"actor_id": "04f37679-bfbf-4906-b749-01756515cecf",
"created_at": "2019-08-24T14:15:22Z",
"data": {
"order_id": "ORD-12345",
"total": "$99.99"
},
"deliveries": [
{
"actor_id": "04f37679-bfbf-4906-b749-01756515cecf",
"archived_at": "2019-08-24T14:15:22Z",
"channel_id": "bbe8aa76-a4bb-46f6-a785-df8e831cc459",
"channel_type": "in_app",
"clicked_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"data": {
"body": "Order ORD-12345 is on its way.",
"subject": "Your order shipped!"
},
"id": "01HQXYZ123456789ABCDEFGHIJ",
"notification_id": "f96afe21-aef9-465c-a9f6-813055655b04",
"notiflow_id": "d74aa67e-7f71-4dba-be64-9b94d47ae12a",
"read_at": "2019-08-24T14:15:22Z",
"recipient_id": "b6731cb5-d462-49ea-afb8-7933b670b560",
"seen_at": "2019-08-24T14:15:22Z",
"sent_at": "2019-08-24T14:15:22Z",
"status": "pending",
"topic": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"id": "01HQXYZ123456789ABCDEFGHIJ",
"notiflow_id": "d74aa67e-7f71-4dba-be64-9b94d47ae12a",
"notiflow_run_id": "d0288227-c772-498b-9c6e-c35b47a2783d",
"processed_at": "2019-08-24T14:15:22Z",
"recipient": {
"avatar": "https://example.com/avatars/jane.jpg",
"created_at": "2024-01-15T10:30:00Z",
"custom_fields": {
"company": "Acme Inc",
"plan": "premium"
},
"email": "jane.doe@example.com",
"external_id": "user_12345",
"first_name": "Jane",
"id": "01HQXYZ123456789ABCDEFGHIJ",
"last_name": "Doe",
"locale": "en-US",
"phone": "+15551234567",
"timezone": "America/New_York",
"updated_at": "2024-01-20T14:45:00Z"
},
"recipient_id": "b6731cb5-d462-49ea-afb8-7933b670b560",
"status": "pending",
"topic": "order-updates",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"page": {
"after": "eyJpZCI6IjAxSFFYWVoxMjM0NTY3ODlBQkNERUZHSElKIn0=",
"before": null,
"has_more_after": true,
"has_more_before": false,
"limit": 25
}
}{
"error": {
"code": "not_found",
"details": {
"allowed_statuses": [
"string"
],
"allowed_transitions": [
"string"
],
"auth": "api_key",
"current_status": "string",
"fields": [
{
"field": "email",
"message": "can't be blank",
"reason": "required"
}
],
"id": "string",
"idempotency_key": "string",
"limit": 0,
"param": "string",
"reason": "string",
"required_scope": "string",
"resource": "string",
"retry_after": 0,
"window": "string"
},
"message": "User not found",
"request_id": "req_abc123",
"status": 404,
"type": "https://docs.notiflows.com/errors/not_found"
}
}{
"error": {
"code": "not_found",
"details": {
"allowed_statuses": [
"string"
],
"allowed_transitions": [
"string"
],
"auth": "api_key",
"current_status": "string",
"fields": [
{
"field": "email",
"message": "can't be blank",
"reason": "required"
}
],
"id": "string",
"idempotency_key": "string",
"limit": 0,
"param": "string",
"reason": "string",
"required_scope": "string",
"resource": "string",
"retry_after": 0,
"window": "string"
},
"message": "User not found",
"request_id": "req_abc123",
"status": 404,
"type": "https://docs.notiflows.com/errors/not_found"
}
}{
"error": {
"code": "not_found",
"details": {
"allowed_statuses": [
"string"
],
"allowed_transitions": [
"string"
],
"auth": "api_key",
"current_status": "string",
"fields": [
{
"field": "email",
"message": "can't be blank",
"reason": "required"
}
],
"id": "string",
"idempotency_key": "string",
"limit": 0,
"param": "string",
"reason": "string",
"required_scope": "string",
"resource": "string",
"retry_after": 0,
"window": "string"
},
"message": "User not found",
"request_id": "req_abc123",
"status": 404,
"type": "https://docs.notiflows.com/errors/not_found"
}
}{
"error": {
"code": "not_found",
"details": {
"allowed_statuses": [
"string"
],
"allowed_transitions": [
"string"
],
"auth": "api_key",
"current_status": "string",
"fields": [
{
"field": "email",
"message": "can't be blank",
"reason": "required"
}
],
"id": "string",
"idempotency_key": "string",
"limit": 0,
"param": "string",
"reason": "string",
"required_scope": "string",
"resource": "string",
"retry_after": 0,
"window": "string"
},
"message": "User not found",
"request_id": "req_abc123",
"status": 404,
"type": "https://docs.notiflows.com/errors/not_found"
}
}