Group Appointment Result

Output representation that contains the details of a specific group appointment.

Sample Response

1{
2    "groupAppointments": [
3        {
4            "appointmentId": "08pxx0000004HlQAAU",
5            "attendeeCount": 10,
6            "attendeeLimit": 25,
7            "parentRecordId": "001B000000qAUAWIA4",
8            "endTime": "2024-01-21T19:15:00.000+0000",
9            "startTime": "2024-01-21T16:15:00.000+0000",
10            "resource": {
11                "id" : "0HnB0000000TO8gKAK",
12                "name" : "Best Resource"
13            },
14            "territoryId": "0HhB0000000TO9WKAW",
15            "engagementChannelTypeId": "0eFRM00000000Bv2AI",
16            "workTypeId": "08qRM00000003fkYAA",
17            "appointmentChannel": {
18                "engagementChannelTypeId" : "0eFRM00000000Bv2AI" ,
19                "engagementChannelTypeName" : "Video"
20            },
21            "workTypeGroup" : {
22                "name" : "Wealth Management",
23                "id" : "0eFRM00000000Bv2AI"
24            },
25            "extendedFields": [ 
26                { "name": "subject", 
27                "value": "MSc Interniship - Resume workshop" }, 
28                { "name": "description", 
29                "value": "Resume workshop for MSc Interniship for Section 4" } 
30            ]
31        },
32        {
33            "appointmentId": "08pxx0000003HpQAAU",
34            "attendeeCount": 0,
35            "attendeeLimit": 15,
36            "parentRecordId": "001B000000qAUAWIA4",
37            "endTime": "2019-01-21T19:30:00.000+0000",
38            "startTime": "2024-01-21T16:15:00.000+0000",
39            "resource": {
40                "id" : "0HnB0000000TO8gKAK",
41                "name" : "Best Resource"
42            },
43            "startTime": "2019-01-21T16:30:00.000+0000",
44            "territoryId": "0HhB0000000TO9WKAW",
45            "engagementChannelTypeId": "0eFRM00000000Bv2AI",
46            "workTypeId": "08qRM00000003fkYAA",
47            "appointmentChannel": {
48                "engagementChannelTypeId" : "0eFRM00000000Bv2AI",
49                "engagementChannelTypeName" : "Video"
50            },
51            "workTypeGroup" : {
52                "name" : "Wealth Management",
53                "id" : "0eFRM00000000Bv2AI"
54            },
55            "extendedFields": [ 
56                { "name": "subject", 
57                "value": "MSc Interniship - Resume workshop" }, 
58                { "name": "description", 
59                "value": "Resume workshop for MSc Interniship for Section 5" } 
60            ]
61        },
62        {
63            "appointmentId": "08pxx0000009AsQAAU",
64            "attendeeCount": 20,
65            "attendeeLimit": 20,
66            "parentRecordId": "001B000000qAUAWIA4",
67            "endTime": "2019-01-21T19:45:00.000+0000",
68            "startTime": "2024-01-21T16:15:00.000+0000",
69            "resource": {
70                "id" : "0HnB0000000TO8gKAK",
71                "name" : "Best Resource"
72            },
73            "startTime": "2019-01-21T16:45:00.000+0000",
74            "territoryId": "0HhB0000000TO9WKAW",
75            "engagementChannelTypeId": "0eFRM00000000Bv2AI",
76            "workTypeId": "08qRM00000003fkYAA",
77            "appointmentChannel": {
78                "engagementChannelTypeId" : "0eFRM00000000Bv2AI",
79                "engagementChannelTypeName" : "Video"
80            },
81            "workTypeGroup" : {
82                "name" : "Wealth Management",
83                "id" : "0eFRM00000000Bv2AI"
84            },
85            "extendedFields": [ 
86                { "name": "subject", 
87                "value": "MSc Interniship - Resume workshop" }, 
88                { "name": "description", 
89                "value": "Resume workshop for MSc Interniship for Section 3" } 
90            ]
91        }
92    ]
93}

Property Name	Type	Description	Filter Group and Version	Available Version
`appointmentId`	String	ID of the group appointment.	Small, 61.0	61.0
`attendeeCount`	Integer	Number of attendees who are already associated with the appointment.	Small, 61.0	61.0
`attendeeLimit`	Integer	Maximum attendee limit that's allowed for the appointment.	Small, 61.0	61.0
`appointmentChannel`	Object	The appointment type, engagement channel type ID, and engagement Channel type name associated with the appointment, based on preferences.	Small, 61.0	61.0
`endTime`	String	End time of the appointment.	Small, 61.0	61.0
`engagementChannelTypeId`	String	ID of the engagement channel type record.	Small, 61.0	61.0
`extendedFields`	Scheduler Extended Fields[]	Details of the extended custom fields.	Small, 61.0	61.0
`parentRecordId`	String	ID of the associated parent record.	Small, 61.0	61.0
`resourceIds`	String[]	Service resource IDs that are associated with the appointment.	Small, 61.0	61.0
`startTime`	String	Start time of the appointment.	Small, 61.0	61.0
`territoryId`	String	ID of the service territory that's associated with the appointment.	Small, 61.0	61.0
`workTypeGroup`	Object	ID and name of the work type group associated with the work type of the appointment.	Small, 61.0	61.0
`workTypeId`	String	ID of the work type for the appointment.	Small, 61.0	61.0

Connect REST API Developer Guide

Group Appointment Result