Skip to main content
GET
Retrieve a maintenance message

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Path Parameters

id
string
required

The id identifier.

Response

200 - application/json

Returns a maintenance message object if a valid identifier was provided.

id
string
required

Unique identifier for the object.

created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

object
enum<string>
required
Available options:
maintenance.message
created_by
object | null
required

The member of the team who sent the message. null on a message from the tenant.

customer
required

The tenant who sent the message. null on a message from the team.

issue
required

The maintenance issue the message belongs to.

sender
enum<string>
required

Which side of the conversation the message came from.

Available options:
team,
tenant
text
string
required

The text content of the message.

account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

deleted
boolean
default:false

Only returned if the object has been deleted.