API reference › Notifications › In-app notifications
Get all in-app notifications for logged-in user
GET /v1/settings/notifications
- Scope
settings_notifications_preferences:read
Retrieve all in-app notifications for the currently authenticated user with pagination
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
limit | integer | Number of notifications to return (without pagination). If not provided, returns with pagination. Example |
per_page | integer | Number of notifications per page when limit is not used (default: 15) Example |
status | string | Filter by read status: all, read, unread One of: |
module | string | Filter by module (e.g., assignment, client, provider) Example |
type | string | Filter by notification type (e.g., assignment_created, provider_assigned) Example |
search | string | Search term to filter notifications Example |
columns | string | Comma-separated list of columns to search in (title, message, type, module). If not provided, searches in all columns including assignment_id and assignment_title from meta Example |
start_date | string (date) | Filter notifications from this date Example |
end_date | string (date) | Filter notifications until this date Example |
sort_by | string | Sort by field (default: created_at) Example |
sort_order | string | Sort order (asc or desc, default: desc) One of: |
time_period | string | Filter by time period One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/settings/notifications" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Notifications retrieved successfully
Notifications retrieved successfully
{
"success": true,
"message": "Notifications retrieved successfully",
"data": {
"notifications": [
{
"id": "NOTIF-123",
"title": "New Assignment",
"message": "You have a new assignment",
"created_at": "2025-12-22T12:00:00Z"
}
],
"total": 5,
"pagination": {
"total": 100,
"perPage": 15,
"currentPage": 1,
"lastPage": 7
}
}
}Response fields (14)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.notifications | array of object | |
data.notifications[].id | string | Example |
data.notifications[].title | string | Example |
data.notifications[].message | string | Example |
data.notifications[].created_at | string (date-time) | Example |
data.total | integer | Example |
data.pagination | object | |
data.pagination.total | integer | Example |
data.pagination.perPage | integer | Example |
data.pagination.currentPage | integer | Example |
data.pagination.lastPage | integer | Example |
401 Not signed in
Unauthorized
{
"success": false,
"message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
"errors": null,
"code": "API_KEY_MISSING"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'settings_notifications_preferences:read' scope.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"success": false,
"message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
"errors": null,
"code": "RATE_LIMITED"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |