getNotificationStatus

GET

/api/v1/notifications/status

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

Read email notification status. Requires an authenticated dashboard user with the read scope.

Responses

200

Notification status

application/json

object

data

required

object

emailConfigured

required

boolean

emailUnavailableReason

required

string

pendingCount

required

integer

recentFailureCount

required

integer

hasDeliveryHistory

required

boolean

Example^generated

{
  "data": {
    "emailConfigured": true,
    "emailUnavailableReason": "example",
    "pendingCount": 1,
    "recentFailureCount": 1,
    "hasDeliveryHistory": true
  }
}

401

Dashboard authentication required

getNotificationStatus

Responses

200

Examplegenerated

401

Example^generated