Get Appointments

GET

https://api.trykeet.com/v1/aesthetic-records/appointments

GET

/v1/aesthetic-records/appointments

$ curl -G https://api.trykeet.com/v1/aesthetic-records/appointments \
>      -H "X-Account-Token: X-Account-Token" \
>      -H "Authorization: Bearer <token>" \
>      -d clinicId=1 \
>      -d startDate=2023-01-15 \
>      -d endDate=2023-01-15 \
>      -d providerIds=1 \
>      -d providerIds=1

1 {
2   "status": "ok",
3   "calendar": {
4     "clinics": [
5       {
6         "id": 1,
7         "clinic_name": "clinic_name"
8       },
9       {
10         "id": 1,
11         "clinic_name": "clinic_name"
12       }
13     ],
14     "providers": [
15       {
16         "id": 1,
17         "firstname": "firstname",
18         "lastname": "lastname",
19         "full_name": "full_name"
20       },
21       {
22         "id": 1,
23         "firstname": "firstname",
24         "lastname": "lastname",
25         "full_name": "full_name"
26       }
27     ],
28     "appointments": [
29       {
30         "accepted": 1,
31         "appointment_booking": {
32           "id": 1,
33           "appointment_id": 1,
34           "booked_by": "booked_by",
35           "booked_by_user": 1,
36           "booking_datetime": "booking_datetime",
37           "booking_payment_id": 1,
38           "firstname": "firstname",
39           "lastname": "lastname",
40           "created": "created",
41           "modified": "modified",
42           "is_override_allowed": 1,
43           "email": "email",
44           "phone": "phone",
45           "appointment_notes": "appointment_notes"
46         },
47         "appointment_cancellation_transaction": [
48           {
49             "id": 1,
50             "appointment_id": 1,
51             "cancellation_fee": 1,
52             "created": "created",
53             "modified": "modified",
54             "charge_days": 1,
55             "status": "status",
56             "authorize_transaction_id": "authorize_transaction_id",
57             "charge_transaction_id": "charge_transaction_id",
58             "refund_transaction_id": "refund_transaction_id",
59             "refund_date": "refund_date",
60             "stripe_user_id": "stripe_user_id"
61           },
62           {
63             "id": 1,
64             "appointment_id": 1,
65             "cancellation_fee": 1,
66             "created": "created",
67             "modified": "modified",
68             "charge_days": 1,
69             "status": "status",
70             "authorize_transaction_id": "authorize_transaction_id",
71             "charge_transaction_id": "charge_transaction_id",
72             "refund_transaction_id": "refund_transaction_id",
73             "refund_date": "refund_date",
74             "stripe_user_id": "stripe_user_id"
75           }
76         ],
77         "appointment_date": "appointment_date",
78         "appointment_end_time": "appointment_end_time",
79         "appointment_services": [
80           {
81             "appointment_id": 1,
82             "created": "created",
83             "modified": "modified",
84             "service": {
85               "id": 1,
86               "name": "name",
87               "duration": 1,
88               "mins": 1,
89               "hours": 1
90             },
91             "service_id": 1
92           },
93           {
94             "appointment_id": 1,
95             "created": "created",
96             "modified": "modified",
97             "service": {
98               "id": 1,
99               "name": "name",
100               "duration": 1,
101               "mins": 1,
102               "hours": 1
103             },
104             "service_id": 1
105           }
106         ],
107         "appointment_start_time": "appointment_start_time",
108         "appointment_timezone": "appointment_timezone",
109         "appointment_type": "appointment_type",
110         "booking_id": 1,
111         "clinic": {
112           "id": 1,
113           "clinic_name": "clinic_name"
114         },
115         "clinic_id": 1,
116         "color": "color",
117         "duration": 1,
118         "is_confirmed": 1,
119         "is_reschedule": 1,
120         "patient_checkedin": 1,
121         "status": "status",
122         "type": "type",
123         "user": {
124           "id": 1,
125           "firstname": "firstname",
126           "lastname": "lastname",
127           "appointment_color": "appointment_color",
128           "full_name": "full_name",
129           "role_name": "role_name",
130           "user_image_url": "user_image_url",
131           "signature_url": "signature_url"
132         },
133         "user_id": 1,
134         "users_id": 1,
135         "appointments_checkin": {
136           "key": "value"
137         },
138         "invoice_id": 1,
139         "meeting_id": "meeting_id",
140         "meeting_type": "meeting_type",
141         "out_of_office": {
142           "key": "value"
143         },
144         "package_id": 1,
145         "patient": {
146           "id": 1,
147           "firstname": "firstname",
148           "lastname": "lastname",
149           "full_name": "full_name",
150           "email": "email",
151           "phoneNumber": "phoneNumber",
152           "user_image_url": "user_image_url",
153           "country_name": "country_name"
154         },
155         "procedure": {
156           "key": "value"
157         }
158       },
159       {
160         "accepted": 1,
161         "appointment_booking": {
162           "id": 1,
163           "appointment_id": 1,
164           "booked_by": "booked_by",
165           "booked_by_user": 1,
166           "booking_datetime": "booking_datetime",
167           "booking_payment_id": 1,
168           "firstname": "firstname",
169           "lastname": "lastname",
170           "created": "created",
171           "modified": "modified",
172           "is_override_allowed": 1,
173           "email": "email",
174           "phone": "phone",
175           "appointment_notes": "appointment_notes"
176         },
177         "appointment_cancellation_transaction": [
178           {
179             "id": 1,
180             "appointment_id": 1,
181             "cancellation_fee": 1,
182             "created": "created",
183             "modified": "modified",
184             "charge_days": 1,
185             "status": "status",
186             "authorize_transaction_id": "authorize_transaction_id",
187             "charge_transaction_id": "charge_transaction_id",
188             "refund_transaction_id": "refund_transaction_id",
189             "refund_date": "refund_date",
190             "stripe_user_id": "stripe_user_id"
191           },
192           {
193             "id": 1,
194             "appointment_id": 1,
195             "cancellation_fee": 1,
196             "created": "created",
197             "modified": "modified",
198             "charge_days": 1,
199             "status": "status",
200             "authorize_transaction_id": "authorize_transaction_id",
201             "charge_transaction_id": "charge_transaction_id",
202             "refund_transaction_id": "refund_transaction_id",
203             "refund_date": "refund_date",
204             "stripe_user_id": "stripe_user_id"
205           }
206         ],
207         "appointment_date": "appointment_date",
208         "appointment_end_time": "appointment_end_time",
209         "appointment_services": [
210           {
211             "appointment_id": 1,
212             "created": "created",
213             "modified": "modified",
214             "service": {
215               "id": 1,
216               "name": "name",
217               "duration": 1,
218               "mins": 1,
219               "hours": 1
220             },
221             "service_id": 1
222           },
223           {
224             "appointment_id": 1,
225             "created": "created",
226             "modified": "modified",
227             "service": {
228               "id": 1,
229               "name": "name",
230               "duration": 1,
231               "mins": 1,
232               "hours": 1
233             },
234             "service_id": 1
235           }
236         ],
237         "appointment_start_time": "appointment_start_time",
238         "appointment_timezone": "appointment_timezone",
239         "appointment_type": "appointment_type",
240         "booking_id": 1,
241         "clinic": {
242           "id": 1,
243           "clinic_name": "clinic_name"
244         },
245         "clinic_id": 1,
246         "color": "color",
247         "duration": 1,
248         "is_confirmed": 1,
249         "is_reschedule": 1,
250         "patient_checkedin": 1,
251         "status": "status",
252         "type": "type",
253         "user": {
254           "id": 1,
255           "firstname": "firstname",
256           "lastname": "lastname",
257           "appointment_color": "appointment_color",
258           "full_name": "full_name",
259           "role_name": "role_name",
260           "user_image_url": "user_image_url",
261           "signature_url": "signature_url"
262         },
263         "user_id": 1,
264         "users_id": 1,
265         "appointments_checkin": {
266           "key": "value"
267         },
268         "invoice_id": 1,
269         "meeting_id": "meeting_id",
270         "meeting_type": "meeting_type",
271         "out_of_office": {
272           "key": "value"
273         },
274         "package_id": 1,
275         "patient": {
276           "id": 1,
277           "firstname": "firstname",
278           "lastname": "lastname",
279           "full_name": "full_name",
280           "email": "email",
281           "phoneNumber": "phoneNumber",
282           "user_image_url": "user_image_url",
283           "country_name": "country_name"
284         },
285         "procedure": {
286           "key": "value"
287         }
288       }
289     ],
290     "resources": [
291       {
292         "id": 1,
293         "firstname": "firstname",
294         "lastname": "lastname",
295         "full_name": "full_name",
296         "working_hours": [
297           {
298             "date": "date",
299             "schedule": [
300               {
301                 "id": 1,
302                 "provider_id": 1,
303                 "clinic_id": 1,
304                 "date_scheduled": "date_scheduled",
305                 "from_time": "from_time",
306                 "to_time": "to_time",
307                 "start": "start",
308                 "end": "end",
309                 "template_name": "template_name",
310                 "date_scheduled_event": "date_scheduled_event",
311                 "schedule_type": "schedule_type",
312                 "available_for": "available_for",
313                 "timezone": "timezone"
314               },
315               {
316                 "id": 1,
317                 "provider_id": 1,
318                 "clinic_id": 1,
319                 "date_scheduled": "date_scheduled",
320                 "from_time": "from_time",
321                 "to_time": "to_time",
322                 "start": "start",
323                 "end": "end",
324                 "template_name": "template_name",
325                 "date_scheduled_event": "date_scheduled_event",
326                 "schedule_type": "schedule_type",
327                 "available_for": "available_for",
328                 "timezone": "timezone"
329               }
330             ]
331           },
332           {
333             "date": "date",
334             "schedule": [
335               {
336                 "id": 1,
337                 "provider_id": 1,
338                 "clinic_id": 1,
339                 "date_scheduled": "date_scheduled",
340                 "from_time": "from_time",
341                 "to_time": "to_time",
342                 "start": "start",
343                 "end": "end",
344                 "template_name": "template_name",
345                 "date_scheduled_event": "date_scheduled_event",
346                 "schedule_type": "schedule_type",
347                 "available_for": "available_for",
348                 "timezone": "timezone"
349               },
350               {
351                 "id": 1,
352                 "provider_id": 1,
353                 "clinic_id": 1,
354                 "date_scheduled": "date_scheduled",
355                 "from_time": "from_time",
356                 "to_time": "to_time",
357                 "start": "start",
358                 "end": "end",
359                 "template_name": "template_name",
360                 "date_scheduled_event": "date_scheduled_event",
361                 "schedule_type": "schedule_type",
362                 "available_for": "available_for",
363                 "timezone": "timezone"
364               }
365             ]
366           }
367         ]
368       },
369       {
370         "id": 1,
371         "firstname": "firstname",
372         "lastname": "lastname",
373         "full_name": "full_name",
374         "working_hours": [
375           {
376             "date": "date",
377             "schedule": [
378               {
379                 "id": 1,
380                 "provider_id": 1,
381                 "clinic_id": 1,
382                 "date_scheduled": "date_scheduled",
383                 "from_time": "from_time",
384                 "to_time": "to_time",
385                 "start": "start",
386                 "end": "end",
387                 "template_name": "template_name",
388                 "date_scheduled_event": "date_scheduled_event",
389                 "schedule_type": "schedule_type",
390                 "available_for": "available_for",
391                 "timezone": "timezone"
392               },
393               {
394                 "id": 1,
395                 "provider_id": 1,
396                 "clinic_id": 1,
397                 "date_scheduled": "date_scheduled",
398                 "from_time": "from_time",
399                 "to_time": "to_time",
400                 "start": "start",
401                 "end": "end",
402                 "template_name": "template_name",
403                 "date_scheduled_event": "date_scheduled_event",
404                 "schedule_type": "schedule_type",
405                 "available_for": "available_for",
406                 "timezone": "timezone"
407               }
408             ]
409           },
410           {
411             "date": "date",
412             "schedule": [
413               {
414                 "id": 1,
415                 "provider_id": 1,
416                 "clinic_id": 1,
417                 "date_scheduled": "date_scheduled",
418                 "from_time": "from_time",
419                 "to_time": "to_time",
420                 "start": "start",
421                 "end": "end",
422                 "template_name": "template_name",
423                 "date_scheduled_event": "date_scheduled_event",
424                 "schedule_type": "schedule_type",
425                 "available_for": "available_for",
426                 "timezone": "timezone"
427               },
428               {
429                 "id": 1,
430                 "provider_id": 1,
431                 "clinic_id": 1,
432                 "date_scheduled": "date_scheduled",
433                 "from_time": "from_time",
434                 "to_time": "to_time",
435                 "start": "start",
436                 "end": "end",
437                 "template_name": "template_name",
438                 "date_scheduled_event": "date_scheduled_event",
439                 "schedule_type": "schedule_type",
440                 "available_for": "available_for",
441                 "timezone": "timezone"
442               }
443             ]
444           }
445         ]
446       }
447     ],
448     "doctor_ids": [
449       1,
450       1
451     ],
452     "clinicOpensAt": "clinicOpensAt",
453     "clinicClosesAt": "clinicClosesAt",
454     "opensAt": "opensAt",
455     "closesAt": "closesAt",
456     "clinic_timezone": "clinic_timezone",
457     "clinic_id": 1,
458     "service_ids": [
459       {
460         "key": "value"
461       },
462       {
463         "key": "value"
464       }
465     ]
466   }
467 }

Get appointments for a list of providers

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

clinicIdintegerRequired

startDatedateRequired

endDatedateRequired

providerIdslist of integersRequired

Response

This endpoint returns an object.

statusenum

calendarobject

Errors

400

Bad Request Error

401

Un Authorized Error

404

Not Found Error

500

Internal Server Error

500

Not Implemented Error

Authentication

Headers

Query parameters

Response

Errors