Notifications

The notification object

Attribute

Type

Description

id

uuid

The unique identifier for the notification.

actor_id

uuid

The unique identifier for the acting user.

actor

string

The name of the acting user.

notification_type

string

The notification type. payment pool request

notification_key

string

An optional key which explains the action of the notification type, such as invited if the user is invited to a money pool.

object_id

uuid

The unique identifier for the object of the specified notification type.

object_data_number

float

An optional number related to the notification's object, such as amount for a payment.

object_data_string

string

An optional message related to the notifications's object.

description

string

The notification message body.

image

Image

An optional notification image.

created_at

time

The time when the notification was created.

updated_at

time

The time when the notification was updated.

Example

{
"id": "68b206f0-ccea-45df-535f-ed16a97e5530",
"actor_id": "92e7370f-8ea0-4b84-b412-776c4129a7c7",
"actor": "Arnar",
"notification_type": "payment",
"notification_key": "request",
"object_id": "74301781-a1eb-41a6-763c-70f235a636b2",
"object_data_number": 20.00,
"object_data_string": "",
"description": "Arnar accepted your friend request",
"image": {
"id": "75cc21be-fe47-4702-74bc-07b84beed5fb",
"url": "https://{imagehost}/ui/payments/c5d8701e-05cf-4b15-52bf-1cf76c3d84f2.jpg",
"full_screen_url": "https://{imagehost}/full/payments/c5d8701e-05cf-4b15-52bf-1cf76c3d84f2.jpg",
"thumbnail_url": "https://{imagehost}/thumbnail/payments/c5d8701e-05cf-4b15-52bf-1cf76c3d84f2.jpg",
"created_at": "2017-09-04T12:26:43.403883Z",
"updated_at": "2017-09-04T12:26:43.403883Z"
},
"created_at": "2015-02-17T23:45:06.872651Z",
"updated_at": "2015-02-17T23:45:06.872651Z"
}

Get a list of notifications

Get a list of all notifications.

Request
Response
Request

GET /v1/notifications

Query Parameters

Name

Type

Description

page

int

Item pagination.

limit

int

Number of items to return per page.

sort

string

Sort the results by created_at, updated_at.

filter

string

Filter the results.

since

string

Show notifications after a certain date and time. Format is YYYY-MM-DD HH:MM:SS.

Response

200 OK

Returns a list of notification objects.

‚Äč