List your notifications

GET

/notifications

const url = 'https://api.nsin.ir/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.nsin.ir/notifications?limit=20' \
  --header 'Authorization: Bearer <token>'

Every event NSIN raised for you — domain lifecycle, uptime, SSL expiry, plan and wallet — newest first. Domain events reach the domain owner and any member subscribed to that category, so this returns your own copy.

total and unread_count always describe the whole feed, not the page or the filter, so they can drive a tab label or a badge directly.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Query Parameters

limit

integer

default: 20 >= 1 <= 100

Page size. Default 20, maximum 100.

before

integer

Return only notifications with a lower id — the cursor for fetching the next page. Use the last id of the previous page.

unread

boolean

Set to true to return only notifications you have not seen.

domain

integer

Restrict the feed to one domain, by numeric domain id. Account-wide notifications (wallet, invoices, tickets) are excluded when set.

Responses

200

Notifications.

application/json

object

items

Array<object>

object

integer

kind

The specific event, for example domain_active, origin_outage, plan_traffic_high or invoice_issued.

string

category

The group the kind belongs to.

string

Allowed values: domain uptime ssl plan billing ticket

domain_id

The domain this is about. Absent for account-wide notifications.

integer

domain_name

Name of domain_id, resolved for convenience.

string

subject

Short title

string

message

The notification body

string

is_unread

You have not marked this seen yet.

boolean

created_at

string format: date-time

total

Notifications in the whole feed.

integer

unread_count

Unseen notifications in the whole feed.

integer

has_more

Another page exists below this one.

boolean

Example

{
  "items": [
    {
      "category": "domain"
    }
  ]
}

401

Missing, malformed, revoked or expired API key — or the owning account is inactive.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

invalidKey

{
  "error": "invalid API key"
}

429

The key exceeded its request budget (300 requests per minute by default).

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

limited

{
  "error": "rate limit exceeded"
}