Skip to content

Notifications

List notifications

notifications:read
ParameterInTypeRequiredDescription
unreadquerystringNotrue — only notifications this API key has not acknowledged
categoryquerystringNooekonomi | sager | opgaver | samarbejde | kunder
langquerystringNoda | en — language of title (default en)
limitqueryintegerNoPage size, 1-200 (default 50)
cursorquerystringNoOpaque cursor from meta.nextCursor
Request exampleNo request body
curl https://api.rieckflow.com/v1/notifications \
-H "Authorization: Bearer $RIECK_API_KEY"
200 Organisation-wide notifications only (those addressed to one colleague are theirs, not the API’s), urgent ones first, newest first. read is THIS key’s acknowledgement. type is the domain’s own type code (see /v1/notification-types), never a translated alias.application/json
Possible errors 5
HTTPCodeMeaning
400invalid_cursorThe cursor is malformed, expired or belongs to another list shape.
401invalid_api_keyThe API key is missing, invalid, expired or revoked.
403api_not_includedThe organisation’s plan does not include API access.
403insufficient_scopeThe key does not have the required scope.
429rate_limitedThe organisation’s rate budget is exhausted.

Unread count for this API key

notifications:read
Request exampleNo request body
curl https://api.rieckflow.com/v1/notifications/unread-count \
-H "Authorization: Bearer $RIECK_API_KEY"
200 data.unread.application/json
Possible errors 4
HTTPCodeMeaning
401invalid_api_keyThe API key is missing, invalid, expired or revoked.
403api_not_includedThe organisation’s plan does not include API access.
403insufficient_scopeThe key does not have the required scope.
429rate_limitedThe organisation’s rate budget is exhausted.

Acknowledge all

notifications:write

Marks every organisation-wide notification as read for this API key’s service account. Colleagues’ unread badges are untouched.

Request exampleNo request body
curl -X POST https://api.rieckflow.com/v1/notifications/read-all \
-H "Authorization: Bearer $RIECK_API_KEY" \
-H "Idempotency-Key: order-2041"
200 data.marked — how many were newly acknowledged.application/json
Possible errors 7
HTTPCodeMeaning
400invalid_idempotency_keyIdempotency-Key is missing or malformed.
401invalid_api_keyThe API key is missing, invalid, expired or revoked.
403api_not_includedThe organisation’s plan does not include API access.
403insufficient_scopeThe key does not have the required scope.
409idempotency_conflictThe same key was used with a different request.
409idempotency_in_progressThe same operation is currently being processed. Retry later.
429rate_limitedThe organisation’s rate budget is exhausted.

Get notification

notifications:read
ParameterInTypeRequiredDescription
notificationIdpathstringYes
langquerystringNoda | en — language of title (default en)
Request exampleNo request body
curl https://api.rieckflow.com/v1/notifications/9b2f1c1e-… \
-H "Authorization: Bearer $RIECK_API_KEY"
200 title rendered in lang, titleKey for grouping, category, caseId, portalPath, urgent, read.application/json
Possible errors 4
HTTPCodeMeaning
401invalid_api_keyThe API key is missing, invalid, expired or revoked.
403api_not_includedThe organisation’s plan does not include API access.
403insufficient_scopeThe key does not have the required scope.
429rate_limitedThe organisation’s rate budget is exhausted.

POST /v1/notifications/{notificationId}/read

Section titled “POST /v1/notifications/{notificationId}/read”

Acknowledge one

notifications:write

Idempotent; the receipt is append-only and per API key.

ParameterInTypeRequiredDescription
notificationIdpathstringYes
Request exampleNo request body
curl -X POST https://api.rieckflow.com/v1/notifications/9b2f1c1e-…/read \
-H "Authorization: Bearer $RIECK_API_KEY" \
-H "Idempotency-Key: order-2041"
204 No contentNo response body
Possible errors 7
HTTPCodeMeaning
400invalid_idempotency_keyIdempotency-Key is missing or malformed.
401invalid_api_keyThe API key is missing, invalid, expired or revoked.
403api_not_includedThe organisation’s plan does not include API access.
403insufficient_scopeThe key does not have the required scope.
409idempotency_conflictThe same key was used with a different request.
409idempotency_in_progressThe same operation is currently being processed. Retry later.
429rate_limitedThe organisation’s rate budget is exhausted.

Notification type catalogue

notifications:read
Request exampleNo request body
curl https://api.rieckflow.com/v1/notification-types \
-H "Authorization: Bearer $RIECK_API_KEY"
200 Every type with its category — the same source the channel matrix uses, so the catalogue cannot drift from it.application/json
Possible errors 4
HTTPCodeMeaning
401invalid_api_keyThe API key is missing, invalid, expired or revoked.
403api_not_includedThe organisation’s plan does not include API access.
403insufficient_scopeThe key does not have the required scope.
429rate_limitedThe organisation’s rate budget is exhausted.