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

NameTypeDescription
limitinteger

Number of notifications to return (without pagination). If not provided, returns with pagination.

Example 5.

per_pageinteger

Number of notifications per page when limit is not used (default: 15)

Example 15.

statusstring

Filter by read status: all, read, unread

One of: all, read, unread. Example all.

modulestring

Filter by module (e.g., assignment, client, provider)

Example assignment.

typestring

Filter by notification type (e.g., assignment_created, provider_assigned)

Example assignment_created.

searchstring

Search term to filter notifications

Example ASG-PTKOK7.

columnsstring

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 title,message.

start_datestring (date)

Filter notifications from this date

Example 2025-01-01.

end_datestring (date)

Filter notifications until this date

Example 2025-12-31.

sort_bystring

Sort by field (default: created_at)

Example created_at.

sort_orderstring

Sort order (asc or desc, default: desc)

One of: asc, desc. Example desc.

time_periodstring

Filter by time period

One of: today, this_week, this_month. Example today.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
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

JSON
{
  "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)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Notifications retrieved successfully.

dataobject
data.notificationsarray of object
data.notifications[].idstring

Example NOTIF-123.

data.notifications[].titlestring

Example New Assignment.

data.notifications[].messagestring

Example You have a new assignment.

data.notifications[].created_atstring (date-time)

Example 2025-12-22T12:00:00Z.

data.totalinteger

Example 5.

data.paginationobject
data.pagination.totalinteger

Example 100.

data.pagination.perPageinteger

Example 15.

data.pagination.currentPageinteger

Example 1.

data.pagination.lastPageinteger

Example 7.

401 Not signed in

Unauthorized

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'settings_notifications_preferences:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.