AUautarc
Jobs

Get an appointment (job) by id

get/jobs/{jobId}

Request

  • Base URL
    https://api3.autarc.energy/v1
  • Auth
    API key in header X-Api-Key

Path parameters

jobIdstring uuid required

Response

One appointment

idstring uuid required
titlestring required
descriptionstring nullable
jobType'consultation' | 'maintenance' | 'repair' | 'emergency' | 'complaint' | 'other' required

Built-in appointment category.

jobTypeIdstring uuid nullable

The company's custom appointment type, when one is set.

startAtstring date-time nullable
endAtstring date-time nullable
addressstring nullable

Free-text address of the appointment.

contactPersonstring nullable
colorstring nullable
projectIdstring uuid nullable
customerIdstring uuid nullable
assignedProfileIdsstring[] required

Team members (profile ids, see GET /team-members) assigned to the appointment.

createdByProfileIdstring uuid nullable
canceledAtstring date-time nullable
cancellationReason'customer_canceled' | 'customer_unavailable' | 'no_access' | 'weather' | 'staff_unavailable' | 'rescheduled' | 'other' | 'null' nullable
cancellationNotestring nullable
companyIdstring uuid required
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.