Retrieves all service messages

Authentication

This endpoint will return different information, depending on if you call this endpoint with an authenticated user or not:

X-Auth-Token Provided?What Kinds of Service Messages Are Returned?What Service Message Locations Are Returned?
No tokenPublished onlyCustomer-facing pages only
X-Auth-Token provided, but user cannot manage service messagesPublished onlyCustomer and staff pages
X-Auth-Token provided and user can manage service messagesPublished and DraftCustomer and staff pages

Response Body

PropertyDescriptionDatatype
idThe unique identifier for the service messageint
dateCreatedThe date the service message was createdstring
createdByThe ID of the user who created the service messageint
titleThe title of the service messagestring
messageThe message contents (may be HTML-encoded).string
styleThe display style of the service message. May be NONE, INFO, NOTICE, SUCCESS, or ERRORstring
publishedtrue if published
false if draft
bool
orderThe display order of the service messageint
iconThe font icon associated with the service message. May be blank.string
locationsList of locations to display the service message. Possible choices:
CUSTOMER_HOME
CUSTOMER_KB_HOME
CUSTOMER_VIEW_KB_ARTICLE
CUSTOMER_SUBMIT_TICKET
CUSTOMER_VIEW_TICKET
STAFF_LOGIN
STAFF_HOME
STAFF_KB_HOME
STAFF_VIEW_KB_ARTICLE
STAFF_SUBMIT_TICKET
* STAFF_VIEW_TICKET
array of strings
languageThe language to display the service message for, or ALL for all languagesstring
Language