Get current notification preferences

GET /api/v1/public/notification-preferences

GET /api/v1/public/notification-preferences

List or read public notification-preferences.

Operation ID: get_api_v1_public_notification_preferences.

Authentication

Choose a credential. Each row is an accepted alternative; access also depends on current roles, project bindings, and entitlements.

CredentialCarrierOAuth scopes
OAuth2Authorization: Bearerprofile:read

For OAuth and service-account credentials, send the selected project UUID in x-project-id, including when the header is optional for legacy keys.

Availability

This operation belongs to the standard API surface. Authentication and authorization still apply.

Request parameters

NameLocationRequiredType / allowed valuesDescription / constraints
x-project-idheaderYesstringx-project-id header parameter; Required OAuth user project selection; format: uuid; Pattern constrained; see the downloadable schema.

Request example

Replace placeholder IDs and environment variables with values from your authorized project. Credentials are expanded into curl's stdin configuration, not its command arguments. Keep shell tracing off and do not log this configuration. For requests with a body, put a payload matching the schema in request-body.txt; form requests use URL-encoded content.

curl --fail-with-body --silent --show-error --config - <<CURL_CONFIG
request = "GET"
header = "Authorization: Bearer ${NEATLOGS_TOKEN}"
header = "x-project-id: ${NEATLOGS_PROJECT_ID}"
url = "https://app.neatlogs.com/api/v1/public/notification-preferences"
CURL_CONFIG

Responses

StatusDescriptionContent type
200Current notification preferencesapplication/json
400Invalid public API requestapplication/problem+json
401Missing or invalid public API credentialapplication/problem+json
403Public API request is not authorizedapplication/problem+json
404Public API resource not foundapplication/problem+json
409Public API request conflictapplication/problem+json
413Public API request body too largeapplication/problem+json
415Unsupported public API request bodyapplication/problem+json
429Public API rate limit exceededapplication/problem+json
500Internal server errorapplication/problem+json
503Public API credential, project context, or rate limiting unavailable. Backend is draining; retry after the Retry-After delay.application/problem+json, application/json

200 response fields

Content type: application/json.

FieldType / allowed valuesRequired in parentDescription / constraints
$objectYesadditionalProperties: false
dataobjectYesadditionalProperties: false
data.approvalRequestsobjectYesadditionalProperties: false
data.approvalRequests.emailbooleanYes—
data.approvalRequests.slackbooleanYes—
data.commentsMentionsobjectYesadditionalProperties: false
data.commentsMentions.emailbooleanYes—
data.commentsMentions.slackbooleanYes—
data.configuredbooleanYes—
data.criticalAlertsobjectYesadditionalProperties: false
data.criticalAlerts.emailbooleanYes—
data.criticalAlerts.slackbooleanYes—
data.dailyDigestobjectYesadditionalProperties: false
data.dailyDigest.emailbooleanYes—
data.dailyDigest.slackbooleanYes—
data.digestTimestringYesPattern constrained; see the downloadable schema.
data.digestTimezonestring | nullYes—
data.digestTimezone (anyOf 1)stringYesmaxLength: 50
data.evalAssignmentsobjectYesadditionalProperties: false
data.evalAssignments.emailbooleanYes—
data.evalAssignments.slackbooleanYes—
data.evalUpdatesobjectYesadditionalProperties: false
data.evalUpdates.emailbooleanYes—
data.evalUpdates.slackbooleanYes—
data.experimentUpdatesobjectYesadditionalProperties: false
data.experimentUpdates.emailbooleanYes—
data.experimentUpdates.slackbooleanYes—
data.nonCriticalAlertsobjectYesadditionalProperties: false
data.nonCriticalAlerts.emailbooleanYes—
data.nonCriticalAlerts.slackbooleanYes—
data.promptChangesobjectYesadditionalProperties: false
data.promptChanges.emailbooleanYes—
data.promptChanges.slackbooleanYes—
data.quietHoursEndstring | nullYes—
data.quietHoursEnd (anyOf 1)stringYesPattern constrained; see the downloadable schema.
data.quietHoursStartstring | nullYes—
data.quietHoursStart (anyOf 1)stringYesPattern constrained; see the downloadable schema.
data.quietHoursTimezonestring | nullYes—
data.quietHoursTimezone (anyOf 1)stringYesmaxLength: 50
data.slackDmEnabledbooleanYes—
requestIdstringYesPattern constrained; see the downloadable schema.
successtrueYes—

Response headers

HeaderDescription / constraints
RateLimit-LimitEffective request ceiling for the current window; minimum: 1
RateLimit-RemainingRequests remaining in the current window; minimum: 0
RateLimit-ResetUnix timestamp in seconds when the current window resets; minimum: 0
X-NeatLogs-RateLimit-DegradedWhether bounded emergency enforcement is active; —
X-NeatLogs-RateLimit-LimitEffective request ceiling for the current window; minimum: 1
X-NeatLogs-RateLimit-PolicyApplied pre-authentication or authenticated rate class; —
X-NeatLogs-RateLimit-RemainingRequests remaining in the current window; minimum: 0
X-NeatLogs-RateLimit-Reset-AfterWhole seconds until the current window resets; minimum: 1
X-NeatLogs-RateLimit-VersionNeatLogs rate-limit contract version; —
X-Request-IdServer-owned request correlation identifier; Pattern constrained; see the downloadable schema.

Failures use Problem Details. For exact validation patterns and all response schemas, download the OpenAPI specification.

On this page

Ask Neatlogs AI

Answers from the docs

How can I help?

Ask anything about instrumenting, tracing, or the Neatlogs dashboard.