Get Appointment Types

GET

Get a list of appointment types for a given provider and modality

Headers

X-Account-TokenstringOptional

Account Token

Query parameters

providerIdintegerRequired

clinicIdintegerRequired

modality"in_person" or "virtual"Required

Allowed values: in_personvirtual

Response

This endpoint returns an object.

status"ok" or "error"

Allowed values: okerror

appointmentTypesobject

GET

1 curl -G https://api.trykeet.com/v1/aesthetic-records/appointment-types \
2      -H "Authorization: Bearer <token>" \
3      -d providerId=1 \
4      -d clinicId=1 \
5      -d modality=in_person

200Retrieved

1 {
2   "status": "ok",
3   "appointmentTypes": {
4     "services": [
5       {
6         "id": 1,
7         "user_id": 1,
8         "name": "name",
9         "category_id": 1,
10         "duration": 1,
11         "custom_duration": 1,
12         "description": "description",
13         "status": 1,
14         "date_created": "date_created",
15         "date_modified": "date_modified",
16         "order_by": 1,
17         "survey_id": 1,
18         "added_by": 1,
19         "modified_by": 1,
20         "deleted_by": 1,
21         "deleted_on": "deleted_on",
22         "is_pre_payment_accepted": 1,
23         "deposit": 1,
24         "price": "price",
25         "service_type": "service_type",
26         "service_charge_type": "service_charge_type",
27         "questionnaire_type": "questionnaire_type",
28         "mins": 1,
29         "hours": 1,
30         "is_device_dependent": 1,
31         "is_available_online": 1,
32         "is_service_free": 1,
33         "is_gfe_required": 1,
34         "free_consultation": 1
35       },
36       {
37         "id": 1,
38         "user_id": 1,
39         "name": "name",
40         "category_id": 1,
41         "duration": 1,
42         "custom_duration": 1,
43         "description": "description",
44         "status": 1,
45         "date_created": "date_created",
46         "date_modified": "date_modified",
47         "order_by": 1,
48         "survey_id": 1,
49         "added_by": 1,
50         "modified_by": 1,
51         "deleted_by": 1,
52         "deleted_on": "deleted_on",
53         "is_pre_payment_accepted": 1,
54         "deposit": 1,
55         "price": "price",
56         "service_type": "service_type",
57         "service_charge_type": "service_charge_type",
58         "questionnaire_type": "questionnaire_type",
59         "mins": 1,
60         "hours": 1,
61         "is_device_dependent": 1,
62         "is_available_online": 1,
63         "is_service_free": 1,
64         "is_gfe_required": 1,
65         "free_consultation": 1
66       }
67     ],
68     "packages": {
69       "key": "value"
70     },
71     "clinic": {
72       "key": "value"
73     }
74   }
75 }

Built with

1	curl -G https://api.trykeet.com/v1/aesthetic-records/appointment-types \
2	-H "Authorization: Bearer <token>" \
3	-d providerId=1 \
4	-d clinicId=1 \
5	-d modality=in_person

1	{
2	"status": "ok",
3	"appointmentTypes": {
4	"services": [
5	{
6	"id": 1,
7	"user_id": 1,
8	"name": "name",
9	"category_id": 1,
10	"duration": 1,
11	"custom_duration": 1,
12	"description": "description",
13	"status": 1,
14	"date_created": "date_created",
15	"date_modified": "date_modified",
16	"order_by": 1,
17	"survey_id": 1,
18	"added_by": 1,
19	"modified_by": 1,
20	"deleted_by": 1,
21	"deleted_on": "deleted_on",
22	"is_pre_payment_accepted": 1,
23	"deposit": 1,
24	"price": "price",
25	"service_type": "service_type",
26	"service_charge_type": "service_charge_type",
27	"questionnaire_type": "questionnaire_type",
28	"mins": 1,
29	"hours": 1,
30	"is_device_dependent": 1,
31	"is_available_online": 1,
32	"is_service_free": 1,
33	"is_gfe_required": 1,
34	"free_consultation": 1
35	},
36	{
37	"id": 1,
38	"user_id": 1,
39	"name": "name",
40	"category_id": 1,
41	"duration": 1,
42	"custom_duration": 1,
43	"description": "description",
44	"status": 1,
45	"date_created": "date_created",
46	"date_modified": "date_modified",
47	"order_by": 1,
48	"survey_id": 1,
49	"added_by": 1,
50	"modified_by": 1,
51	"deleted_by": 1,
52	"deleted_on": "deleted_on",
53	"is_pre_payment_accepted": 1,
54	"deposit": 1,
55	"price": "price",
56	"service_type": "service_type",
57	"service_charge_type": "service_charge_type",
58	"questionnaire_type": "questionnaire_type",
59	"mins": 1,
60	"hours": 1,
61	"is_device_dependent": 1,
62	"is_available_online": 1,
63	"is_service_free": 1,
64	"is_gfe_required": 1,
65	"free_consultation": 1
66	}
67	],
68	"packages": {
69	"key": "value"
70	},
71	"clinic": {
72	"key": "value"
73	}
74	}
75	}