Sign in

v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB
Notifications

Get in-app notifications

Rate limit: 60 requests per 60 seconds. This is the default shared quota — it is shared with every other endpoint that has no dedicated limit, so requests across those endpoints all draw from the same budget.

Retrieves all in-app notifications for the authenticated user. Rate limit: 1 request per second.

get/api/v1/notifications/messages

Headers

x-request-idstring uuid required
Example:87b1c6ff-5f6a-470b-94c3-1a7196df9027

A unique request identifier.

x-api-keystring password required
Example:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

API key for authentication.

x-user-keystring password required
Example:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

User-specific authentication key.

Response

Notifications retrieved successfully

Example response

{
  "messages": [
    {
      "messageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ],
  "meta": {
    "notSeen": 5
  }
}