GET   messages?active={active}&customerId={customerId}

Gets a list of UI messages. UI messages are used for user notifications on announcements/information/warnings.

URL Parameters

Name	Description
active	Set to 'true' to get only active messages, 'false' to get all messages. If not specified then 'true' is the default value.
customerId	Filter by customer ID. Can be any existing customer (for the root administrators) or any of sub-customers or current customer (for customer administrators). If not specified then all available messages will be returned.

Request example

curl --request GET "https://api-asm1.apica.io/v3/messages?active=true&customerId=4533&auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E"

Response body model example and description

Message

[
  {
    "id": 1,
    "text": "sample string 2",
    "message_is_from": "sample string 3",
    "from_date_utc": "2024-09-27T11:08:49",
    "to_date_utc": "2024-09-27T11:08:49",
    "importance": "sample string 6",
    "enabled": true,
    "customer_id": 1,
    "include_sub_customers": true
  },
  {
    "id": 1,
    "text": "sample string 2",
    "message_is_from": "sample string 3",
    "from_date_utc": "2024-09-27T11:08:49",
    "to_date_utc": "2024-09-27T11:08:49",
    "importance": "sample string 6",
    "enabled": true,
    "customer_id": 1,
    "include_sub_customers": true
  },
  {
    "id": 1,
    "text": "sample string 2",
    "message_is_from": "sample string 3",
    "from_date_utc": "2024-09-27T11:08:49",
    "to_date_utc": "2024-09-27T11:08:49",
    "importance": "sample string 6",
    "enabled": true,
    "customer_id": 1,
    "include_sub_customers": true
  }
]

Name	Type	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.