Documentation menu

Developer API · resource

Appointments

Calendar bookings with a customer, including reminders.

Scope appointments:read for reads · appointments:write for changes

Operations

GET/v1/appointmentsList — see list
POST/v1/appointmentsCreate — see create
GET/v1/appointments/{id}Read — see get
PATCH/v1/appointments/{id}Update — see update
DELETE/v1/appointments/{id}Delete — see delete
Minimal create
curl -X POST https://api2.djcsystem.com/v1/appointments \
  -H "Authorization: Bearer $DJC_TOKEN" -H "Content-Type: application/json" \
  -d '{ "custName": "…", "custContact": "…", "startDate": "2026-09-10T02:00:00Z", "endDate": "2026-09-10T02:00:00Z", "timezone": "…" }'

Fields

Fields you may send on create. Updatable marks fields accepted by PATCH. Anything not listed is server-owned or hidden.

FieldTypeOn createUpdatable
namestringoptionalyes
custNamestringrequiredyes
custContactstringrequiredyes
custEmailstringoptionalyes
descriptionstringoptionalyes
startDatedatetimerequiredyes
endDatedatetimerequiredyes
timezonestringrequiredyes
locationTypeenum(in_person|phone|video)optionalyes
locationstringoptionalyes
durationnumberoptionalyes
eventTypeIdstringoptionalyes
notesstringoptionalyes
sendReminderbooleanoptionalyes
sendReminderToClientbooleanoptionalyes
sendReminderToSelfbooleanoptionalyes

Filters & sorting

FilterableeventTypeIdcustContactcustEmail
SortablestartDatecreatedDatedate
Default orderstartDate:asc

Good to know

  • `startDate`/`endDate` are ISO-8601 with offset. `timezone` is an IANA name such as `Asia/Kuala_Lumpur`.