Skip to main content
GET
/
system
/
system-toasts
Get System Toasts
curl --request GET \
  --url https://api.decodahealth.com/system/system-toasts \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "id": 123,
    "content": "<string>",
    "variant": "error",
    "module": "<string>",
    "author": "kevin",
    "displayDuration": 123,
    "imageUrls": [
      "<string>"
    ],
    "roleTypes": [
      "ADMIN"
    ]
  }
]

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Response

200 - application/json

Successful Response

​
id
integer
required

The unique identifier of the toast

​
content
string
required

The content of the toast message

​
variant
enum<string>
required

The variant/type of the toast

Available options:
error,
info,
warning
​
module
string | null

The module this toast is for, if any

​
author
enum<string> | null

The author of the toast

Available options:
kevin,
chase,
james,
nour
​
displayDuration
integer | null

Duration in milliseconds to show the toast

​
imageUrls
string[] | null

The image URLs of the toast

​
roleTypes
enum<string>[] | null

List of role types. Toast will only show to users with any of these role types. If None, shows to all users.

Available options:
ADMIN,
PROVIDER,
USER