Get Sales Appointments

GET

https://api.trykeet.com/v1/vin/sales/appointments

GET

/v1/vin/sales/appointments

1 curl -G https://api.trykeet.com/v1/vin/sales/appointments \
2      -H "X-Account-Token: X-Account-Token" \
3      -H "Authorization: Bearer <token>" \
4      -d pageNumber=1 \
5      -d pageSize=1 \
6      -d startDate=startDate \
7      -d endDate=endDate \
8      -d dealerId=dealerId

Try it

200Retrieved

1 {
2   "status": "ok",
3   "href": "href",
4   "first": "first",
5   "previous": "previous",
6   "next": "next",
7   "limit": 1,
8   "count": 1,
9   "appointments": [
10     {
11       "id": 1,
12       "dealer": {
13         "id": 1,
14         "name": "name"
15       },
16       "customer": {
17         "id": 1,
18         "firstName": "firstName",
19         "lastName": "lastName",
20         "email": "email",
21         "homePhoneNumber": "homePhoneNumber",
22         "workPhoneNumber": "workPhoneNumber",
23         "cellPhoneNumber": "cellPhoneNumber",
24         "address": {
25           "streetAddress": "streetAddress",
26           "city": "city",
27           "state": "state",
28           "postalCode": "postalCode"
29         },
30         "href": "href"
31       },
32       "lead": {
33         "id": 1,
34         "autoId": 1,
35         "vehicle": {
36           "id": 1,
37           "vehicleType": "vehicleType",
38           "inventoryType": "inventoryType",
39           "status": "status",
40           "make": "make",
41           "model": "model",
42           "year": 1,
43           "stockNumber": {
44             "key": "value"
45           },
46           "href": "href"
47         },
48         "href": "href"
49       },
50       "location": {
51         "type": "type",
52         "name": "name",
53         "address": {
54           "streetAddress": "streetAddress",
55           "city": "city",
56           "state": "state",
57           "postalCode": "postalCode"
58         }
59       },
60       "status": "status",
61       "isConfirmed": true,
62       "startTimeUtc": "startTimeUtc",
63       "endTimeUtc": "endTimeUtc",
64       "assignedUser": {
65         "href": "href"
66       },
67       "lastEditedDateUtc": "lastEditedDateUtc",
68       "href": "href",
69       "appointmentType": "appointmentType",
70       "visit": {
71         "id": 1,
72         "href": "href"
73       },
74       "purpose": "purpose",
75       "completedByUser": {
76         "href": "href"
77       }
78     },
79     {
80       "id": 1,
81       "dealer": {
82         "id": 1,
83         "name": "name"
84       },
85       "customer": {
86         "id": 1,
87         "firstName": "firstName",
88         "lastName": "lastName",
89         "email": "email",
90         "homePhoneNumber": "homePhoneNumber",
91         "workPhoneNumber": "workPhoneNumber",
92         "cellPhoneNumber": "cellPhoneNumber",
93         "address": {
94           "streetAddress": "streetAddress",
95           "city": "city",
96           "state": "state",
97           "postalCode": "postalCode"
98         },
99         "href": "href"
100       },
101       "lead": {
102         "id": 1,
103         "autoId": 1,
104         "vehicle": {
105           "id": 1,
106           "vehicleType": "vehicleType",
107           "inventoryType": "inventoryType",
108           "status": "status",
109           "make": "make",
110           "model": "model",
111           "year": 1,
112           "stockNumber": {
113             "key": "value"
114           },
115           "href": "href"
116         },
117         "href": "href"
118       },
119       "location": {
120         "type": "type",
121         "name": "name",
122         "address": {
123           "streetAddress": "streetAddress",
124           "city": "city",
125           "state": "state",
126           "postalCode": "postalCode"
127         }
128       },
129       "status": "status",
130       "isConfirmed": true,
131       "startTimeUtc": "startTimeUtc",
132       "endTimeUtc": "endTimeUtc",
133       "assignedUser": {
134         "href": "href"
135       },
136       "lastEditedDateUtc": "lastEditedDateUtc",
137       "href": "href",
138       "appointmentType": "appointmentType",
139       "visit": {
140         "id": 1,
141         "href": "href"
142       },
143       "purpose": "purpose",
144       "completedByUser": {
145         "href": "href"
146       }
147     }
148   ]
149 }

Get a list of sales appointments

Query parameters

pageNumberintegerRequired

pageSizeintegerRequired

startDatestringRequired

endDatestringRequired

dealerIdstringRequired

Response

This endpoint returns an object.

statusenum

Allowed values:

hrefstring

firststring

previousstring

nextstring

limitinteger

countinteger

appointmentslist of objects

Get Sales Appointments

Headers

Query parameters

Response

Errors