BizKitHub
DocsAPI ReferenceOrganisation/bff/organisation/notification-preference
getpostOrganisationAdmin BFF

/bff/organisation/notification-preference

Returns the per-organisation opt-in / opt-out overrides for internal platform notifications. Each preference is nullable: true = force on, false = force off, null = fall back to the platform default (also included in the response so the UI can display "Default (on)" or "Default (off)").

OrganisationgetBffOrganisationNotification-preference

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200Success
preferencesobjectRequired
experimentNotificationboolean | nullRequired
One of 2:
Variant 1
boolean
Variant 2
null
dailyLogReportNotificationboolean | nullRequired
One of 2:
Variant 1
boolean
Variant 2
null
orderCreatedInternalNotificationboolean | nullRequired
One of 2:
Variant 1
boolean
Variant 2
null
expensePendingApprovalNotificationboolean | nullRequired
One of 2:
Variant 1
boolean
Variant 2
null
issueCreatedNotificationboolean | nullRequired
One of 2:
Variant 1
boolean
Variant 2
null
issueCommentNotificationboolean | nullRequired
One of 2:
Variant 1
boolean
Variant 2
null
paymentGatewayOutageNotificationboolean | nullRequired
One of 2:
Variant 1
boolean
Variant 2
null
organisationTechnicalNotificationboolean | nullRequired
One of 2:
Variant 1
boolean
Variant 2
null
defaultsobjectRequired
experimentNotificationbooleanRequired
dailyLogReportNotificationbooleanRequired
orderCreatedInternalNotificationbooleanRequired
expensePendingApprovalNotificationbooleanRequired
issueCreatedNotificationbooleanRequired
issueCommentNotificationbooleanRequired
paymentGatewayOutageNotificationbooleanRequired
organisationTechnicalNotificationbooleanRequired

Response example

application/json
{
  "preferences": {},
  "defaults": {
    "experimentNotification": false,
    "dailyLogReportNotification": false,
    "orderCreatedInternalNotification": false,
    "expensePendingApprovalNotification": false,
    "issueCreatedNotification": false,
    "issueCommentNotification": false,
    "paymentGatewayOutageNotification": false,
    "organisationTechnicalNotification": false
  }
}

Request example

GET /bff/organisation/notification-preference

get
curl -X GET "https://api.bizkithub.com/bff/organisation/notification-preference" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key