Skip to content
IndepAI API Docs

List Notifications

GET
/api/v1/notifications

Get the authenticated user’s notifications with pagination and optional unread-only filter.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
limit

Number of notifications to return (max 100)

integer
default: 50 >= 1 <= 100
Example
50
offset

Offset for pagination

integer | null
0
0
unread_only

Filter to unread notifications only

string
default: false
Allowed values: true false
Example
false

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Notifications list

object
success
required
boolean
data
required
Array<object>
object
id
required

Notification ID

string format: uuid
user_id
required

User ID

string format: uuid
type
required

Notification type

string
Example
fi_score_update
title
required

Notification title

string
Example
Your FI Score increased!
message
required

Notification message body

string
read
required

Whether the notification has been read

boolean
created_at
required

When the notification was created

string format: date-time
Example
2024-01-15T10:30:00Z
expires_at

When the notification expires

string | null format: date-time
Example
2024-01-15T10:30:00Z
meta
required
object
total
required

Total notification count

integer
unread
required

Unread notification count

integer

401

Section titled “401 ”

Unauthorized

object
success
required

Always false for error responses

boolean
error
required

Error type

string
Example
Validation error
code

Machine-readable error code

string
Example
VALIDATION_ERROR
details

Detailed validation errors

Array<object>
object
path
required

Path to the invalid field

string
Example
currentAge
message
required

Error message

string
Example
Must be between 18 and 100