Service Visit

The service visit resource.

Base/serviceVisit

GET/serviceVisit

List service visits

Retrieve a paginated list of service visits. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/serviceVisit

curl --request GET \
  --url '<your-host>/serviceVisit?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "serviceJobId": "xyz789",
    "sequence": 0,
    "dayOrder": 0,
    "plannedDate": "2026-01-01",
    "status": "string",
    "createdBy": "string"
  }
]

GET/serviceVisit

Retrieve a service visit

Fetch a single service visit by filtering on `id`.

Query parameters

idstring

Match on the service visit's `id`, e.g. `eq.{id}`.

GET/serviceVisit

curl --request GET \
  --url '<your-host>/serviceVisit?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "serviceJobId": "xyz789",
  "sequence": 0,
  "dayOrder": 0,
  "plannedDate": "2026-01-01",
  "status": "string",
  "createdBy": "string"
}

POST/serviceVisit

Create a service visit

Create a new service visit.

Body parameters

serviceJobIdstringrequired

sequencenumberrequired

dayOrdernumberrequired

plannedDatedaterequired

plannedStartstring

plannedEndstring

technicianEmployeeIdstring

vehicleIdstring

References vehicle.id

statusstringrequired

supersededByVisitIdstring

rescheduleReasonstring

cancelReasonstring

actualStarttimestamp

actualEndtimestamp

outcomestring

notesstring

commandIdstring

POST/serviceVisit

curl --request POST \
  --url <your-host>/serviceVisit \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"serviceJobId":"xyz789","sequence":0,"dayOrder":0,"plannedDate":"2026-01-01","status":"string"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "serviceJobId": "xyz789",
  "sequence": 0,
  "dayOrder": 0,
  "plannedDate": "2026-01-01",
  "status": "string",
  "createdBy": "string"
}

PATCH/serviceVisit

Update a service visit

Update an existing service visit, matched on `id`.

Body parameters

serviceJobIdstringrequired

sequencenumberrequired

dayOrdernumberrequired

plannedDatedaterequired

plannedStartstring

plannedEndstring

technicianEmployeeIdstring

vehicleIdstring

References vehicle.id

statusstringrequired

supersededByVisitIdstring

rescheduleReasonstring

cancelReasonstring

actualStarttimestamp

actualEndtimestamp

outcomestring

notesstring

commandIdstring

PATCH/serviceVisit

curl --request PATCH \
  --url '<your-host>/serviceVisit?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"serviceJobId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "serviceJobId": "xyz789",
  "sequence": 0,
  "dayOrder": 0,
  "plannedDate": "2026-01-01",
  "status": "string",
  "createdBy": "string"
}

DELETE/serviceVisit

Delete a service visit

Delete a service visit, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the service visit to delete, e.g. `eq.{id}`.

DELETE/serviceVisit

curl --request DELETE \
  --url '<your-host>/serviceVisit?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content