GET   messages/{id}

Gets an existing UI message by Id.

URL Parameters


The message's numeric identifier.

Request example

curl --request GET ""

Response body model example and description


  "id": 1,
  "text": "sample string 2",
  "message_is_from": "sample string 3",
  "from_date_utc": "2023-06-08T17:37:10",
  "to_date_utc": "2023-06-08T17:37:10",
  "importance": "sample string 6",
  "enabled": true,
  "customer_id": 1,
  "include_sub_customers": true
NameType Description
id Integer

The message's numeric identifier.

text String

Text of the message.

message_is_from String

Text about the message sender.

from_date_utc DateTime

Message activity start date and time.

to_date_utc DateTime

Message activity end date and time.

importance String

Message importance. Possible values: "L"/"H"/"C" ("Low","High","Critical").

enabled Boolean

Indicates whether the message is enabled or not.

customer_id Integer

Customer Id. Сustomer who’s users will get the message.

include_sub_customers Boolean

Include sub-customers users as targets of the message.