Organization API

List Service Appointments

Lists Service Appointments tied to public API-accessible project-contained Work Orders. Supports Work Order, status, Team Member, and interval-overlap filters. Required scope: service_appointments:read.

/api/v1/service-appointments

List Service Appointments. Use an organization API key with service_appointments:read. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

service_appointments:read

Parameters

Name	In	Type	Description
limit	query	integer	Maximum records to return. Defaults to 50 and is capped at 100.
cursor	query	string	Opaque record cursor from the previous response meta.nextCursor value.
sortDir	query	asc \| desc	Sort direction. Defaults to desc.
workOrderId	query	string	Filter by containing Work Order id.
status	query	SCHEDULED \| DISPATCHED \| EN_ROUTE \| IN_PROGRESS \| COMPLETED \| CANCELLED \| CANNOT_COMPLETE	Filter by exact operational status.
teamMemberId	query	string	Filter to appointments assigned to this Team Member.
dateStart	query	string	ISO date-time lower bound. Returns appointments whose scheduled interval ends after this instant.
dateEnd	query	string	ISO date-time upper bound. Returns appointments whose scheduled interval starts before this instant.

Request body

This endpoint does not accept a JSON request body.

Responses

200

Service Appointment list envelope

#/components/schemas/OrgApiListEnvelope

401

Missing or invalid organization API key

#/components/schemas/OrgApiError

402

Organization billing access or an endpoint-specific business quota denied the request

#/components/schemas/OrgApiError

403

Missing required scope: service_appointments:read

#/components/schemas/OrgApiError

429

Rate limit exceeded

#/components/schemas/OrgApiError

Errors

401 Missing or invalid organization API key402 Organization billing access or an endpoint-specific business quota denied the request403 Missing required scope: service_appointments:read429 Rate limit exceeded

Static examples

curl -X GET "$SOLAROS_BASE_URL/api/v1/service-appointments" \
  -H "Authorization: Bearer $SOLAROS_API_KEY"