Get Clients

GET

1 curl https://api.trykeet.com/v1/aesthetic-records/clients \
2      -H "X-Account-Token: X-Account-Token" \
3      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 {
2   "status": "ok",
3   "clients": [
4     {
5       "clinic": {
6         "id": 1,
7         "clinic_name": "clinic_name"
8       },
9       "country_name": {
10         "key": "value"
11       },
12       "documentsExpirationDate": {
13         "key": "value"
14       },
15       "last_appointment": [
16         {
17           "id": 1,
18           "patient_id": 1,
19           "appointment_datetime": "appointment_datetime",
20           "appointment_start_on": "appointment_start_on",
21           "appointment_endtime": "appointment_endtime",
22           "date": "date",
23           "time": "time",
24           "format_time": "format_time",
25           "format_date": "format_date",
26           "meeting_url": "meeting_url",
27           "start_time": "start_time",
28           "end_time": "end_time",
29           "appointment_timezone_abbr": "appointment_timezone_abbr",
30           "display_status": "display_status"
31         },
32         {
33           "id": 1,
34           "patient_id": 1,
35           "appointment_datetime": "appointment_datetime",
36           "appointment_start_on": "appointment_start_on",
37           "appointment_endtime": "appointment_endtime",
38           "date": "date",
39           "time": "time",
40           "format_time": "format_time",
41           "format_date": "format_date",
42           "meeting_url": "meeting_url",
43           "start_time": "start_time",
44           "end_time": "end_time",
45           "appointment_timezone_abbr": "appointment_timezone_abbr",
46           "display_status": "display_status"
47         }
48       ],
49       "leadStar": true,
50       "patient_membership_subscription": [
51         {
52           "key": "value"
53         },
54         {
55           "key": "value"
56         }
57       ],
58       "procedure": [
59         {
60           "key": "value"
61         },
62         {
63           "key": "value"
64         }
65       ],
66       "upcoming_appointment_count": 1,
67       "user_image_url": "user_image_url"
68     },
69     {
70       "clinic": {
71         "id": 1,
72         "clinic_name": "clinic_name"
73       },
74       "country_name": {
75         "key": "value"
76       },
77       "documentsExpirationDate": {
78         "key": "value"
79       },
80       "last_appointment": [
81         {
82           "id": 1,
83           "patient_id": 1,
84           "appointment_datetime": "appointment_datetime",
85           "appointment_start_on": "appointment_start_on",
86           "appointment_endtime": "appointment_endtime",
87           "date": "date",
88           "time": "time",
89           "format_time": "format_time",
90           "format_date": "format_date",
91           "meeting_url": "meeting_url",
92           "start_time": "start_time",
93           "end_time": "end_time",
94           "appointment_timezone_abbr": "appointment_timezone_abbr",
95           "display_status": "display_status"
96         },
97         {
98           "id": 1,
99           "patient_id": 1,
100           "appointment_datetime": "appointment_datetime",
101           "appointment_start_on": "appointment_start_on",
102           "appointment_endtime": "appointment_endtime",
103           "date": "date",
104           "time": "time",
105           "format_time": "format_time",
106           "format_date": "format_date",
107           "meeting_url": "meeting_url",
108           "start_time": "start_time",
109           "end_time": "end_time",
110           "appointment_timezone_abbr": "appointment_timezone_abbr",
111           "display_status": "display_status"
112         }
113       ],
114       "leadStar": true,
115       "patient_membership_subscription": [
116         {
117           "key": "value"
118         },
119         {
120           "key": "value"
121         }
122       ],
123       "procedure": [
124         {
125           "key": "value"
126         },
127         {
128           "key": "value"
129         }
130       ],
131       "upcoming_appointment_count": 1,
132       "user_image_url": "user_image_url"
133     }
134   ],
135   "pagination": {
136     "current_page": 1,
137     "first_page_url": "first_page_url",
138     "from": 1,
139     "last_page": 1,
140     "links": [
141       {
142         "label": "label",
143         "active": true,
144         "url": "url"
145       },
146       {
147         "label": "label",
148         "active": true,
149         "url": "url"
150       }
151     ],
152     "path": "path",
153     "per_page": {
154       "key": "value"
155     },
156     "to": 1,
157     "total": 1,
158     "last_page_url": "last_page_url",
159     "next_page_url": "next_page_url",
160     "prev_page_url": "prev_page_url"
161   }
162 }

Get a list of clients.

Query parameters

pageintegerOptional

pageSizeintegerOptional

Response

This endpoint returns an object.

statusenum

Allowed values:

clientslist of objects

paginationobject

Get Clients

Headers

Query parameters

Response

Errors