Get Sales Appointment

GET

Get a sales appointment

Headers

X-Account-TokenstringRequired

The account token that is associated with the end user linked to this account

Query parameters

appointmentIdstringRequired

dealerIdstringRequired

Response

This endpoint returns an object.

status"ok" or "error"

Allowed values: okerror

appointmentobject

GET

1 curl -G https://api.trykeet.com/v1/vin/sales/appointment \
2      -H "X-Account-Token: X-Account-Token" \
3      -H "Authorization: Bearer <token>" \
4      -d appointmentId=appointmentId \
5      -d dealerId=dealerId

200Retrieved

1 {
2   "status": "ok",
3   "appointment": {
4     "id": 1,
5     "dealer": {
6       "id": 1,
7       "name": "name"
8     },
9     "customer": {
10       "id": 1,
11       "firstName": "firstName",
12       "lastName": "lastName",
13       "email": "email",
14       "homePhoneNumber": "homePhoneNumber",
15       "workPhoneNumber": "workPhoneNumber",
16       "cellPhoneNumber": "cellPhoneNumber",
17       "address": {
18         "streetAddress": "streetAddress",
19         "city": "city",
20         "state": "state",
21         "postalCode": "postalCode"
22       },
23       "href": "href"
24     },
25     "lead": {
26       "id": 1,
27       "autoId": 1,
28       "vehicle": {
29         "id": 1,
30         "vehicleType": "vehicleType",
31         "inventoryType": "inventoryType",
32         "status": "status",
33         "make": "make",
34         "model": "model",
35         "year": 1,
36         "stockNumber": {
37           "key": "value"
38         },
39         "href": "href"
40       },
41       "href": "href"
42     },
43     "location": {
44       "type": "type",
45       "name": "name",
46       "address": {
47         "streetAddress": "streetAddress",
48         "city": "city",
49         "state": "state",
50         "postalCode": "postalCode"
51       }
52     },
53     "status": "status",
54     "isConfirmed": true,
55     "startTimeUtc": "startTimeUtc",
56     "endTimeUtc": "endTimeUtc",
57     "assignedUser": {
58       "href": "href"
59     },
60     "lastEditedDateUtc": "lastEditedDateUtc",
61     "href": "href",
62     "appointmentType": "appointmentType",
63     "visit": {
64       "id": 1,
65       "href": "href"
66     },
67     "purpose": "purpose",
68     "completedByUser": {
69       "href": "href"
70     }
71   }
72 }

Built with

1	curl -G https://api.trykeet.com/v1/vin/sales/appointment \
2	-H "X-Account-Token: X-Account-Token" \
3	-H "Authorization: Bearer <token>" \
4	-d appointmentId=appointmentId \
5	-d dealerId=dealerId

1	{
2	"status": "ok",
3	"appointment": {
4	"id": 1,
5	"dealer": {
6	"id": 1,
7	"name": "name"
8	},
9	"customer": {
10	"id": 1,
11	"firstName": "firstName",
12	"lastName": "lastName",
13	"email": "email",
14	"homePhoneNumber": "homePhoneNumber",
15	"workPhoneNumber": "workPhoneNumber",
16	"cellPhoneNumber": "cellPhoneNumber",
17	"address": {
18	"streetAddress": "streetAddress",
19	"city": "city",
20	"state": "state",
21	"postalCode": "postalCode"
22	},
23	"href": "href"
24	},
25	"lead": {
26	"id": 1,
27	"autoId": 1,
28	"vehicle": {
29	"id": 1,
30	"vehicleType": "vehicleType",
31	"inventoryType": "inventoryType",
32	"status": "status",
33	"make": "make",
34	"model": "model",
35	"year": 1,
36	"stockNumber": {
37	"key": "value"
38	},
39	"href": "href"
40	},
41	"href": "href"
42	},
43	"location": {
44	"type": "type",
45	"name": "name",
46	"address": {
47	"streetAddress": "streetAddress",
48	"city": "city",
49	"state": "state",
50	"postalCode": "postalCode"
51	}
52	},
53	"status": "status",
54	"isConfirmed": true,
55	"startTimeUtc": "startTimeUtc",
56	"endTimeUtc": "endTimeUtc",
57	"assignedUser": {
58	"href": "href"
59	},
60	"lastEditedDateUtc": "lastEditedDateUtc",
61	"href": "href",
62	"appointmentType": "appointmentType",
63	"visit": {
64	"id": 1,
65	"href": "href"
66	},
67	"purpose": "purpose",
68	"completedByUser": {
69	"href": "href"
70	}
71	}
72	}