curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/notification-settings \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/notification-settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/notification-settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Notification settings fetched successfully."
},
"data": {
"id": "6721a9e0c4b5d6e7f8a9b0c1",
"organizationId": "66a0f1e2d3c4b5a697887766",
"notifyEmails": [
"ana.lopez@example.com",
"revops@example.com"
],
"eventTypes": [
{
"type": "deal.approval",
"frequency": "immediate"
},
{
"type": "task.created",
"frequency": "daily"
},
{
"type": "organization.daily_summary",
"frequency": "daily"
}
],
"isActive": true,
"metadata": {
"created": {
"at": "2026-10-02T08:15:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
},
"updated": {
"at": "2026-11-04T09:30:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
}
}
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}Get notification settings
Returns the workspace’s notification settings: whether notifications are on, who receives them, and which events notify and how often.
These are workspace settings, not settings of the person who owns the API key. Everyone in the workspace reads and edits the same document.
A workspace that has never saved settings has none: the response then has data: {} and
meta.message “No notification settings found.”, and no notification emails are sent (except
integration.not_synced).
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/notification-settings \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/notification-settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/notification-settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Notification settings fetched successfully."
},
"data": {
"id": "6721a9e0c4b5d6e7f8a9b0c1",
"organizationId": "66a0f1e2d3c4b5a697887766",
"notifyEmails": [
"ana.lopez@example.com",
"revops@example.com"
],
"eventTypes": [
{
"type": "deal.approval",
"frequency": "immediate"
},
{
"type": "task.created",
"frequency": "daily"
},
{
"type": "organization.daily_summary",
"frequency": "daily"
}
],
"isActive": true,
"metadata": {
"created": {
"at": "2026-10-02T08:15:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
},
"updated": {
"at": "2026-11-04T09:30:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
}
}
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}heliyos_notification_settings_get.Authorizations
A workspace API key, sent as Authorization: Bearer heliyos_.... Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in.
Response
The settings, or an empty object when the workspace has never saved any. The message is "Notification settings fetched successfully." when settings exist and "No notification settings found." when they do not.
Was this page helpful?

