/v0/notifications

GET

/v0/notifications

const url = 'http://localhost:3000/v0/notifications?limit=30&include_read=false';
const options = {method: 'GET'};

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

curl --request GET \
  --url 'http://localhost:3000/v0/notifications?limit=30&include_read=false'

Get notifications

Parameters

Query Parameters

limit

number

default: 30 >= 1 <= 50

after_id

Return notes after this notification ID. Specified notification is not included.

string

Return notes after this notification ID. Specified notification is not included.

include_read

boolean | null

Responses

200

application/json

Array

Any of:

object

required

string

actor

required

object

type

required

Any of:

string
string

string

Allowed values: account

required

string

name

required

string

nickname

required

string

avatar

required

string format: uri

createdAt

required

string format: date-time

type

required

string

Allowed values: followed

Example

[
  {
    "actor": {
      "type": "account"
    },
    "type": "followed"
  }
]

404

Nothing left

application/json

object

error

required

No more notes exist

string

Allowed values: NOTHING_LEFT

Example

{
  "error": "NOTHING_LEFT"
}

500

Internal error

application/json

object

error

required

Internal server error

string

Allowed values: INTERNAL_ERROR

Example

{
  "error": "INTERNAL_ERROR"
}