Skip to main content
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.issue
application
required

The application the issue is associated with.

assignee
required

The user the issue is assigned to.

availability
object | null
required

When the customer is available for a visit. null when availability has not been set.

customer_presence_requested
boolean
required

Whether the customer's presence is requested during the maintenance visit.

customer_request
boolean
required

Whether the issue was raised by a customer.

description
string | null
required

A description of the maintenance issue.

first_responded_at
integer | null
required

The time at which the issue was first responded to, which stops the response clock.

is_communal
boolean
required

Whether the issue is in a communal area.

issue_category
enum<string> | null
required

The high-level category of the issue.

Available options:
air_conditioning,
appliance,
electricity,
exterior,
heating_system,
housekeeping,
housing,
locksmith,
other,
painting,
pest_control,
plumbing,
null
issue_sub_category
string | null
required

A more specific sub-category for the issue.

name
string | null
required

The name of the maintenance issue.

on_hold
object | null
required

Hold details for the issue, which pause its SLA clock and exclude it from performance metrics. null when the issue is not on hold.

photos
string[]
required

IDs of files used as photos for the issue.

priority
number
required

The priority of the issue, where higher numbers indicate higher priority.

Required range: 0 <= x <= 4
resolved
boolean
required

Whether the issue has been resolved.

resolved_at
integer | null
required

The time at which the issue was resolved.

sla
object | null
required

The issue standing against its response and resolution targets. null when no targets applied when it was raised.

status
enum<string>
required

The status of the maintenance issue.

Available options:
in_progress,
open,
resolved
triage
object | null
required

Triage configuration for the issue. null when triage is not enabled.

type
enum<string>
required

The type of the maintenance issue.

Available options:
customer_request,
internal,
planned
unit
required

The unit the issue is associated with.

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.

metadata
object | null

Metadata for the maintenance issue.

videos
string[]

IDs of files used as videos for the issue.