Sign in
Notifications

Get paginated notifications for user

Retrieve paginated notifications for the authenticated user with pagination metadata and total unread count matching the current filters

get/api/notification/{page}

Request

  • Base URL: https://api.sc-market.space
  • URL: https://api.sc-market.space/api/notification/{page}
  • Auth: none declared

Path parameters

pageinteger required

Page number (0-based)

Query parameters

pageSizeinteger

Number of notifications per page (1-100, default: 20)

action'order_create' | 'order_assigned' | 'order_status_fulfilled' | 'order_status_in_progress' | 'order_status_not_started' | 'order_status_cancelled' | 'order_comment' | 'order_review' | 'order_review_revision_requested' | 'order_contractor_applied' | 'public_order_create' | 'order_message' | 'offer_create' | 'counter_offer_create' | 'offer_message' | 'market_item_bid' | 'market_item_offer' | 'market_bid_accepted' | 'market_bid_declined' | 'market_offer_accepted' | 'market_offer_declined' | 'contractor_invite' | 'admin_alert'

Available notification action types for filtering and identification

Example:order_message

Filter notifications by action type. See NotificationActionType schema for available values. Examples: 'order_message', 'offer_message', 'order_create', 'market_item_bid'

entityIdstring uuid

Filter notifications by entity ID (e.g., order ID, market listing ID). The entity type is determined by the action filter.

scope'individual' | 'organization' | 'all'

Filter notifications by scope: 'individual' for personal notifications, 'organization' for org notifications, 'all' for all notifications.

contractorIdstring uuid

Filter notifications by specific organization/contractor ID. Only applies when scope is 'organization'.

Response

Paginated notifications retrieved successfully

unread_countinteger required

Total number of unread notifications matching the current search criteria

Example response

{
  "notifications": [
    {
      "read": false,
      "notification_id": "123e4567-e89b-12d3-a456-426614174000",
      "action": "order_message",
      "actors": [
        {
          "username": "john_doe",
          "avatar": "https://example.com/avatar.jpg"
        }
      ],
      "entity_type": "orders",
      "entity": {
        "order_id": "456e7890-e89b-12d3-a456-426614174000",
        "title": "Sample Order"
      },
      "timestamp": "2025-01-22T06:14:41.058Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 5 revisions of this API.