Notifications
GET /v1/notifications
Section titled “GET /v1/notifications”| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
unread | query | string | No | true — only notifications this API key has not acknowledged |
category | query | string | No | oekonomi | sager | opgaver | samarbejde | kunder |
lang | query | string | No | da | en — language of title (default en) |
limit | query | integer | No | Page size, 1-200 (default 50) |
cursor | query | string | No | Opaque cursor from meta.nextCursor |
Request exampleNo request body
curl https://api.rieckflow.com/v1/notifications \ -H "Authorization: Bearer $RIECK_API_KEY"const svar = await rieck.request("GET", "/v1/notifications");{ "data": [ {} ], "meta": { "nextCursor": null }}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/jsonPossible errors 5
| HTTP | Code | Meaning |
|---|---|---|
| 400 | invalid_cursor | The cursor is malformed, expired or belongs to another list shape. |
| 401 | invalid_api_key | The API key is missing, invalid, expired or revoked. |
| 403 | api_not_included | The organisation’s plan does not include API access. |
| 403 | insufficient_scope | The key does not have the required scope. |
| 429 | rate_limited | The organisation’s rate budget is exhausted. |
GET /v1/notifications/unread-count
Section titled “GET /v1/notifications/unread-count”Request exampleNo request body
curl https://api.rieckflow.com/v1/notifications/unread-count \ -H "Authorization: Bearer $RIECK_API_KEY"const svar = await rieck.request("GET", "/v1/notifications/unread-count");{ "data": {}}200
data.unread.application/jsonPossible errors 4
| HTTP | Code | Meaning |
|---|---|---|
| 401 | invalid_api_key | The API key is missing, invalid, expired or revoked. |
| 403 | api_not_included | The organisation’s plan does not include API access. |
| 403 | insufficient_scope | The key does not have the required scope. |
| 429 | rate_limited | The organisation’s rate budget is exhausted. |
POST /v1/notifications/read-all
Section titled “POST /v1/notifications/read-all”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"const svar = await rieck.request("POST", "/v1/notifications/read-all");{ "data": {}}200
data.marked — how many were newly acknowledged.application/jsonPossible errors 7
| HTTP | Code | Meaning |
|---|---|---|
| 400 | invalid_idempotency_key | Idempotency-Key is missing or malformed. |
| 401 | invalid_api_key | The API key is missing, invalid, expired or revoked. |
| 403 | api_not_included | The organisation’s plan does not include API access. |
| 403 | insufficient_scope | The key does not have the required scope. |
| 409 | idempotency_conflict | The same key was used with a different request. |
| 409 | idempotency_in_progress | The same operation is currently being processed. Retry later. |
| 429 | rate_limited | The organisation’s rate budget is exhausted. |
GET /v1/notifications/{notificationId}
Section titled “GET /v1/notifications/{notificationId}”| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
notificationId | path | string | Yes | |
lang | query | string | No | da | en — language of title (default en) |
Request exampleNo request body
curl https://api.rieckflow.com/v1/notifications/9b2f1c1e-… \ -H "Authorization: Bearer $RIECK_API_KEY"const svar = await rieck.request("GET", "/v1/notifications/9b2f1c1e-…");{ "data": {}}200
title rendered in lang, titleKey for grouping, category, caseId, portalPath, urgent, read.application/jsonPossible errors 4
| HTTP | Code | Meaning |
|---|---|---|
| 401 | invalid_api_key | The API key is missing, invalid, expired or revoked. |
| 403 | api_not_included | The organisation’s plan does not include API access. |
| 403 | insufficient_scope | The key does not have the required scope. |
| 429 | rate_limited | The organisation’s rate budget is exhausted. |
POST /v1/notifications/{notificationId}/read
Section titled “POST /v1/notifications/{notificationId}/read”Idempotent; the receipt is append-only and per API key.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
notificationId | path | string | Yes |
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"const svar = await rieck.request("POST", "/v1/notifications/9b2f1c1e-…/read");204 No contentNo response body
Possible errors 7
| HTTP | Code | Meaning |
|---|---|---|
| 400 | invalid_idempotency_key | Idempotency-Key is missing or malformed. |
| 401 | invalid_api_key | The API key is missing, invalid, expired or revoked. |
| 403 | api_not_included | The organisation’s plan does not include API access. |
| 403 | insufficient_scope | The key does not have the required scope. |
| 409 | idempotency_conflict | The same key was used with a different request. |
| 409 | idempotency_in_progress | The same operation is currently being processed. Retry later. |
| 429 | rate_limited | The organisation’s rate budget is exhausted. |
GET /v1/notification-types
Section titled “GET /v1/notification-types”Request exampleNo request body
curl https://api.rieckflow.com/v1/notification-types \ -H "Authorization: Bearer $RIECK_API_KEY"const svar = await rieck.request("GET", "/v1/notification-types");{ "data": {}}200 Every
type with its category — the same source the channel matrix uses, so the catalogue cannot drift from it.application/jsonPossible errors 4
| HTTP | Code | Meaning |
|---|---|---|
| 401 | invalid_api_key | The API key is missing, invalid, expired or revoked. |
| 403 | api_not_included | The organisation’s plan does not include API access. |
| 403 | insufficient_scope | The key does not have the required scope. |
| 429 | rate_limited | The organisation’s rate budget is exhausted. |