200Successful Response
Schema: SuccessEnvelope_NotificationCountResponse_
successbooleanmessagestringcodestringdataNotificationCountResponse
/api/v1/notifications/countUnread (new only) count for the bell badge by default. Pass unread_only=false for the legacy open (new + seen) count.
Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.
scope_business_idstringOptional: scope to a single business
business_idstringDeprecated alias for scope_business_id
unread_onlybooleandefault: TrueWhen true (default), count only unread (new) rows. When false, count open rows (new + seen + expired snoozes).
Schema: SuccessEnvelope_NotificationCountResponse_
successbooleanmessagestringcodestringdataNotificationCountResponseSchema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.