---
title: Get user's notifications
slug: api-documentation/get-users-notifications
docTags:
createdAt: 2026-08-27T16:57:16.574Z
---
{
"id": "jqCuztaNokJxtoGF3oZTU",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "https://api.upstartcommerce.com/notifications/v1/notifications",
"servers": [
{
"url": "https://api.upstartcommerce.com/notifications/v1/notifications",
"description": "Production server"
},
{
"url": "https://staging-api.upstartcommerce.com/notifications/v1/notifications",
"description": "Staging server"
},
{
"url": "http://localhost:8080/api/v1/notifications",
"description": "Local development server"
}
],
"name": "Get user's notifications",
"description": "Retrieve notifications for the authenticated user.
\nSecurity: Requires notification:manage permission.\nUsers can only see their own notifications.
",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
}
],
"queryParameters": [
{
"kind": "optional",
"name": "unread_only",
"type": "boolean",
"description": "Only return unread notifications",
"default": false
},
{
"kind": "optional",
"name": "limit",
"type": "integer",
"description": "Maximum number of notifications to return",
"default": 50,
"minimum": 1,
"maximum": 100
},
{
"kind": "optional",
"name": "offset",
"type": "integer",
"description": "Number of notifications to skip",
"default": 0,
"minimum": 0
}
],
"bodyDataParameters": [],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "oauth2",
"name": "oauth2",
"kind": "optional",
"type": "oauth2",
"description": "OAuth2 with JWT bearer tokens",
"oauth2Flows": {
"clientCredentials": {
"tokenUrl": "https://auth.upstartcommerce.com/oauth/token",
"scopes": {
"notification:manage": "Full access to manage own notifications"
}
},
"authorizationCode": {
"authorizationUrl": "https://auth.upstartcommerce.com/oauth/authorize",
"tokenUrl": "https://auth.upstartcommerce.com/oauth/token",
"scopes": {
"notification:manage": "Full access to manage own notifications"
}
}
},
"requiredScopes": [
"notification:manage"
]
}
],
"cookieParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "Notifications retrieved successfully",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "GetNotificationsResponse",
"schema": [
{
"name": "notifications",
"kind": "required",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/NotificationEvent",
"customType": "NotificationEvent[]",
"schema": [
{
"name": "eventId",
"kind": "required",
"type": "string",
"description": "Unique identifier for the notification",
"format": "uuid"
},
{
"name": "eventType",
"kind": "required",
"type": "string",
"description": "Type of notification event",
"example": "system_alert"
},
{
"name": "title",
"kind": "required",
"type": "string",
"description": "Notification title",
"example": "System Maintenance"
},
{
"name": "message",
"kind": "required",
"type": "string",
"description": "Notification message content",
"example": "Scheduled maintenance will begin at 2 AM UTC"
},
{
"name": "timestamp",
"kind": "required",
"type": "string",
"description": "When the notification was created",
"format": "date-time"
},
{
"name": "userId",
"kind": "required",
"type": "string",
"description": "User who owns this notification",
"format": "uuid"
},
{
"name": "tenantId",
"kind": "required",
"type": "string",
"description": "Tenant identifier"
},
{
"name": "priority",
"kind": "required",
"type": "string",
"description": "Notification priority level",
"enum": [
"LOW",
"NORMAL",
"HIGH",
"URGENT"
]
},
{
"name": "data",
"kind": "optional",
"type": "map",
"description": "Additional notification data",
"example": "",
"customType": "map",
"schema": []
},
{
"name": "readAt",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "When the notification was marked as read",
"format": "date-time"
},
{
"name": "isRead",
"kind": "required",
"type": "boolean",
"description": "Whether the notification has been read"
}
]
},
{
"name": "totalCount",
"kind": "required",
"type": "integer",
"description": "Total number of notifications (with current offset)
"
},
{
"name": "unreadCount",
"kind": "required",
"type": "integer",
"description": "Number of unread notifications for the user"
},
{
"name": "hasMore",
"kind": "required",
"type": "boolean",
"description": "Whether there are more notifications available"
}
],
"modelRef": "#/components/schemas/GetNotificationsResponse",
"isExpanded": true
}
]
},
{
"statusCode": "401",
"description": "Authentication failed",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "error",
"kind": "required",
"type": "string",
"description": "Error code",
"enum": [
"authentication_failed",
"insufficient_permissions",
"invalid_request",
"not_found"
]
},
{
"name": "error_description",
"kind": "required",
"type": "string",
"description": "Human-readable error description
"
},
{
"name": "required_scope",
"kind": "optional",
"type": "string",
"description": "Required OAuth2 scope (for permission errors)
"
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
},
{
"statusCode": "403",
"description": "Insufficient permissions",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "error",
"kind": "required",
"type": "string",
"description": "Error code",
"enum": [
"authentication_failed",
"insufficient_permissions",
"invalid_request",
"not_found"
]
},
{
"name": "error_description",
"kind": "required",
"type": "string",
"description": "Human-readable error description
"
},
{
"name": "required_scope",
"kind": "optional",
"type": "string",
"description": "Required OAuth2 scope (for permission errors)
"
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "2RaNO6ZeHTgM1h5YLN1TI",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url 'https://api.upstartcommerce.com/notifications/v1/notifications?unread_only=boolean&limit=50&offset=integer' \\\n --header 'accept: application/json'"
},
{
"id": "GWr3XOsjTzpl1iDpxDK3a",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/notifications/v1/notifications?unread_only=boolean&limit=50&offset=integer\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "UykgPueRtn4R-zjpU3uLE",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/notifications/v1/notifications?unread_only=boolean&limit=50&offset=integer\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "MHoYX7iw6rXJqL2PKC0OG",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/notifications/v1/notifications?unread_only=boolean&limit=50&offset=integer\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "2RaNO6ZeHTgM1h5YLN1TI"
},
"results": {
"languages": [
{
"id": "MLFIlGXnycxFwziW5d7u6",
"language": "200",
"code": "// Notifications retrieved successfully\n{\n \"notifications\": [\n {\n \"eventId\": \"\",\n \"eventType\": \"system_alert\",\n \"title\": \"System Maintenance\",\n \"message\": \"Scheduled maintenance will begin at 2 AM UTC\",\n \"timestamp\": \"\",\n \"userId\": \"\",\n \"tenantId\": \"\",\n \"priority\": \"\",\n \"data\": \"\",\n \"readAt\": \"\",\n \"isRead\": false\n }\n ],\n \"totalCount\": 0,\n \"unreadCount\": 0,\n \"hasMore\": false\n}"
},
{
"id": "A0JEiGjWhhzmT5ieG1bpw",
"language": "401",
"code": "// Authentication failed\n{\n \"error\": \"\",\n \"error_description\": \"\",\n \"required_scope\": \"\"\n}"
},
{
"id": "7R5c6AbmRHiwUI0XMpeBk",
"language": "403",
"code": "// Insufficient permissions\n{\n \"error\": \"\",\n \"error_description\": \"\",\n \"required_scope\": \"\"\n}"
}
],
"selectedLanguageId": "MLFIlGXnycxFwziW5d7u6"
}
},
"children": [
{
"text": ""
}
]
}