Schema ServiceOrderAppointment

ServiceOrderAppointment (object)

Scheduled dispatch / visit window for a service order (Gantt bar source)

Feld

Typ

Beschreibung

assignee

object

Feld

Typ

Beschreibung

abilities

string[]

Ability strings for this account user. Included when listing or getting users (admin editing). Omitted in embedded contexts (e.g. documents, projects, service orders) to avoid leaking permission data.

array

Elemente

string

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

display_email

string

—

display_name

string

—

display_phone

string

—

id*

integer

—

invited_email

string

Email address the user was invited with. Set for pending account users; null after acceptance or when not applicable.

role*

string

user
admin

status*

string

active
blocked
pending

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

user

object

Feld	Typ	Beschreibung
email*	string	—
id*	integer	—
image_url	string	—
name*	string	—

assignee_account_user_id

integer

—

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

ends_at*

string

Local datetime without timezone (Y-m-dTH:i:s)

id*

integer

—

service_order*

object

Parent order summary; always present when returned from the API.

Feld	Typ	Beschreibung
contact_name	string	Contact display name for scheduling views without loading full contact
formatted_number*	string	—
id*	integer	—
service_location	string	—
status*	string	string open planned in_progress done invoiced cancelled
subject	string	—

service_order_id*

integer

—

starts_at*

string

Local datetime without timezone (Y-m-dTH:i:s)

status*

string

planned
confirmed
completed
cancelled

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

Beispiel (JSON)

{
  "id": 0,
  "service_order_id": 0,
  "service_order": {
    "id": 0,
    "formatted_number": "string",
    "subject": "string",
    "service_location": "string",
    "contact_name": "string",
    "status": "open"
  },
  "starts_at": "2025-01-14T09:00:00",
  "ends_at": "2025-01-14T17:00:00",
  "assignee_account_user_id": 0,
  "status": "planned"
}