GET /api/account/service-order-appointments

get/api/account/service-order-appointments

Example request

GET https://api.jupiter-erp.com/api/account/service-order-appointments

Code

curl -X GET 'https://api.jupiter-erp.com/api/account/service-order-appointments' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'X-Account-Uuid: YOUR_ACCOUNT_UUID' \
  -H 'Accept: application/json'

Parameters

Name	In	Required	Description
service_order_id	query	no	Filter by service order.
contact_id	query	no	Filter by contact (via linked service order).
project_id	query	no	Filter by project (via linked service order).
service_contract_id	query	no	Filter by service contract (via linked service order).
status	query	no	—
assignee_account_user_id	query	no	—
starts_from	query	no	Filter appointments with starts_at on or after this date (Y-m-d).
starts_to	query	no	Filter appointments with starts_at on or before this date (Y-m-d).
order_by	query	no	—
#/components/parameters/OrderDirParameter
#/components/parameters/PerPageParameter
#/components/parameters/PageParameter

Responses

200OK

ModelListServiceOrderAppointments200Response

Field

Type

Description

data*

object[]

array

Elements

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

Field

Type

Description

assignee

object

Field

Type

Description

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

Elements

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

Field	Type	Description
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.

Field	Type	Description
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.

meta*

object

Field	Type	Description
current_page*	integer	The current page number.
items_from*	integer	The starting item number on the current page.
items_to*	integer	The ending item number on the current page.
last_page*	integer	The last page number.
per_page*	integer	The number of items per page.
total*	integer	The total number of items.

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 1,
    "items_from": 1,
    "items_to": 1
  }
}

Service order appointments

Questions about integration?