List notifications

GET

/notifications

const url = 'https://shoehorn.example.com/api/v1/notifications?limit=20';
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 'https://shoehorn.example.com/api/v1/notifications?limit=20'

Returns notifications for the current user.

Parameters

Query Parameters

limit

integer

default: 20 <= 100

cursor

string

unread

boolean

Filter to unread only

Responses

200

User notifications

application/json

object

notifications

Array<object>

object

string format: uuid

type

string

Allowed values: info warning error success

title

string

message

string

url

Deep link to related resource

string

entity_id

string

read

boolean

created_at

string format: date-time

unread_count

integer

pagination

object

nextCursor

string

Example

{
  "notifications": [
    {
      "type": "info"
    }
  ]
}