Get Availability

GET

Get a list of provider availability for a given date and service.

Headers

X-Account-TokenstringOptional

Account Token

Query parameters

appointmentType"in_person" or "virtual"Required

Allowed values: in_personvirtual

clinicIdintegerRequired

durationintegerOptional

Duration in minutes of appointment

providerIdslist of integersRequired

The providers that you want to get availability for

serviceIdslist of integersRequired

The services/types of appointments that you want to get availability for. See getAppointmentTypes for how to view the list of available services and their ids.

startDatedateRequired

Response

This endpoint returns an object.

status"ok" or "error"

Allowed values: okerror

availabilityobject

GET

1 curl -G https://api.trykeet.com/v1/aesthetic-records/availability \
2      -H "Authorization: Bearer <token>" \
3      -d appointmentType=in_person \
4      -d clinicId=1 \
5      -d "providerIds[]"=1 \
6      -d "providerIds[]"=1 \
7      -d "serviceIds[]"=1 \
8      -d "serviceIds[]"=1 \
9      -d startDate=2023-01-15

200Retrieved

1 {
2   "status": "ok",
3   "availability": {
4     "available_days": {
5       "available_days": {
6         "available_days": [
7           "available_days",
8           "available_days"
9         ]
10       }
11     },
12     "provider": {
13       "status": "status",
14       "user_role_id": 1,
15       "bio_description": "bio_description",
16       "bio_name": "bio_name",
17       "role_name": "role_name",
18       "signature_url": "signature_url",
19       "user_image": "user_image",
20       "user_image_url": "user_image_url"
21     },
22     "unique_dates": [
23       "unique_dates",
24       "unique_dates"
25     ],
26     "time_format": "time_format",
27     "first_available": {
28       "first_available": {
29         "first_available": [
30           "first_available",
31           "first_available"
32         ]
33       }
34     }
35   }
36 }

Built with

1	curl -G https://api.trykeet.com/v1/aesthetic-records/availability \
2	-H "Authorization: Bearer <token>" \
3	-d appointmentType=in_person \
4	-d clinicId=1 \
5	-d "providerIds[]"=1 \
6	-d "providerIds[]"=1 \
7	-d "serviceIds[]"=1 \
8	-d "serviceIds[]"=1 \
9	-d startDate=2023-01-15

1	{
2	"status": "ok",
3	"availability": {
4	"available_days": {
5	"available_days": {
6	"available_days": [
7	"available_days",
8	"available_days"
9	]
10	}
11	},
12	"provider": {
13	"status": "status",
14	"user_role_id": 1,
15	"bio_description": "bio_description",
16	"bio_name": "bio_name",
17	"role_name": "role_name",
18	"signature_url": "signature_url",
19	"user_image": "user_image",
20	"user_image_url": "user_image_url"
21	},
22	"unique_dates": [
23	"unique_dates",
24	"unique_dates"
25	],
26	"time_format": "time_format",
27	"first_available": {
28	"first_available": {
29	"first_available": [
30	"first_available",
31	"first_available"
32	]
33	}
34	}
35	}
36	}