/service-messages

GET https://www.mods-for-hesk.com/demo/api/index.php/v1/service-messages

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 token	Published only	Customer-facing pages only
X-Auth-Token provided, but user cannot manage service messages	Published only	Customer and staff pages
X-Auth-Token provided and user can manage service messages	Published and Draft	Customer and staff pages

Response Body

Property	Description	Datatype
id	The unique identifier for the service message	int
dateCreated	The date the service message was created	string
createdBy	The ID of the user who created the service message	int
title	The title of the service message	string
message	The message contents (may be HTML-encoded).	string
style	The display style of the service message. May be NONE, INFO, NOTICE, SUCCESS, or ERROR	string
published	true if published false if draft	bool
order	The display order of the service message	int
icon	The font icon associated with the service message. May be blank.	string
locations	List 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
language	The language to display the service message for, or ALL for all languages	string