List in-app notifications for the current account (newest first).

GET

/v1/notifications

const url = 'https://api.share2.us/v1/notifications?limit=20';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.share2.us/v1/notifications?limit=20' \
  --header 'Authorization: Bearer <token>'

Authorizations

Parameters

Query Parameters

limit

integer

default: 20 >= 1 <= 50

before

string format: date-time

RFC3339 cursor; returns notifications created strictly before it.

Responses

200

A page of notifications plus the unread count.

application/json

object

items

required

Array<object>

object

required

string format: uuid

type

required

string

title

required

string

body

string

nullable

data

object

key

additional properties

any

action

object

kind

required

string

email

string format: email

group_count

required

Number of coalesced events represented by this row.

integer

created_at

required

string format: date-time

updated_at

required

string format: date-time

read_at

string format: date-time

nullable

unread_count

required

integer format: int64

next_cursor

required

RFC3339 cursor for the next page, or empty when there are no more.

string

Example

{
  "items": [
    {
      "type": "share.received",
      "action": {
        "kind": "trust_contact"
      }
    }
  ]
}

default

Standard error envelope.

application/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "quota_exceeded"
  }
}