Get notifications

GET 
/v1/notifications

Get notifications

The get user notifications endpoint retrieves a list of notifications for a specific user, including both transactional and ordinary notifications. It supports pagination and filtering by date range. The response includes detailed information about each notification, such as the associated transaction details, NFTs, or tokens involved, along with basic notification metadata like title and description.

Request

Query Parameters

page int32

Page

page_size int32

Page size

end_date date-time

End date

start_date date-time

Start date

Responses

200

User notifications found

application/json

Schema

Schema

billing booleanrequired
cryptoNews booleanrequired
hasNewNotifications booleanrequired
id uuidrequired
marketing booleanrequired
notifications object[]required
Array [
createdAt date-timerequired
description stringnullable
invite objectnullable
accountId uuidnullable
accountName stringnullable
createdAt date-timenullable
id uuidrequired
inviteeEmail stringnullable
inviteeId uuidnullable
inviterId uuidnullable
inviterName stringnullable
status stringnullable
title stringnullable
transaction objectnullable
actionType stringrequired
coin objectnullable
decimals int32nullable
id uuidrequired
name stringnullable
symbol stringnullable
createdAt date-timerequired
fromAccount objectnullable
approversQuantity int32nullable
id uuidnullable
name stringnullable
fromAddress stringrequired
fromUser objectnullable
id uuidnullable
name stringnullable
fromWalletId uuidnullable
hash stringnullable
id uuidrequired
networkId int32required
nft objectnullable
image stringnullable
name stringnullable
symbol stringnullable
status stringnullable
toAccount objectnullable
approversQuantity int32nullable
id uuidnullable
name stringnullable
toAddress stringrequired
toContact objectnullable
id uuidnullable
name stringnullable
tokenAddress stringnullable
tokenId stringnullable
value stringnullable
]
popularPriceChange booleanrequired
priceChangeAccounts uuid[]nullable
transactionAboveLimit int32nullable
userId uuidrequired

Example (from schema)

{
  "billing": true,
  "cryptoNews": true,
  "hasNewNotifications": true,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "marketing": true,
  "notifications": [
    {
      "createdAt": "2024-09-25T19:42:12.494Z",
      "description": "string",
      "invite": {
        "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "accountName": "string",
        "createdAt": "2024-09-25T19:42:12.495Z",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "inviteeEmail": "string",
        "inviteeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "inviterId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "inviterName": "string",
        "status": "string"
      },
      "title": "string",
      "transaction": {
        "actionType": "string",
        "coin": {
          "decimals": 0,
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "symbol": "string"
        },
        "createdAt": "2024-09-25T19:42:12.495Z",
        "fromAccount": {
          "approversQuantity": 0,
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        },
        "fromAddress": "string",
        "fromUser": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        },
        "fromWalletId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "hash": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "networkId": 0,
        "nft": {
          "image": "string",
          "name": "string",
          "symbol": "string"
        },
        "status": "string",
        "toAccount": {
          "approversQuantity": 0,
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        },
        "toAddress": "string",
        "toContact": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        },
        "tokenAddress": "string",
        "tokenId": "string",
        "value": "string"
      }
    }
  ],
  "popularPriceChange": true,
  "priceChangeAccounts": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "transactionAboveLimit": 0,
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

500

Internal server error

text/plain

Schema

Schema

string

Loading...