Group Appointments (POST)

Get a list of group appointments along with the remaining attendee limit.

Resource

1/connect/scheduling/group-appointments

Resource example

1https://yourInstance.salesforce.com/services/data/v67.0/connect/scheduling/group-appointments

Available version

61.0

HTTP methods

POST

Request body for POST

JSON example

1{
2  "startTime": "2024-01-23T00:00:00.000Z",
3  "endTime": "2024-02-28T00:00:00.000Z",
4  "filterByWorkTypes": [
5    "08qRM00000003fkYAA"
6  ],
7  "filterByResources": [
8    "0HnB0000000TO8gKAK"
9  ],
10  "filterByTerritories": [
11    "0HhRM00000003OZ0AY"
12  ],
13  "filterByParentRecords": [
14    "001B000000qAUAWIA4"
15  ],
16  "filterByEngagementChannelTypes": [
17    "0eFRM00000000Bv2AI"
18  ],
19  "extendedFieldsToQuery": [
20    "subject",
21    "description"
22  ]
23}

Properties

Name	Type	Description	Required or Optional	Available Version
`endTime`	String	Latest end time for the group appointments to be retrieved.	Optional	61.0
`excludeAssociatedAppts`	Boolean	Indicates whether the response excludes appointments where the current user is associated as an attendee or assigned resource (`true`) or not (`false`).	Optional	61.0
`extendedFieldsToQuery`	String[]	List of the extended custom fields to fetch in the output.	Optional	61.0
`filterByEngagementChannelTypes`	String[]	ID of the engagement channel type record. Group appointments are filtered based on the selected engagement channel type.	Optional	61.0
`filterByParentRecords`	String[]	The ID of the associated parent record.	Optional	61.0
`filterByResources`	String[]	List of the group appointments where all the given resources are present.	Optional	61.0
`filterByTerritories`	String[]	List of IDs of the service territories where the requested work is performed.	Optional	61.0
`filterByWorkTypeGroups`	String[]	IDs of the work type groups containing the work types that are being performed.	Optional	61.0
`filterByWorkTypes`	String[]	List of IDs of the work types to be performed.	Optional	61.0
`limit`	Integer	Maximum number of records to be fetched.	Optional	61.0
`offset`	Integer	Number of records to be skipped.	Optional	61.0
`startTime`	String	The earliest start time for the group appointments to be retrieved. If not provided, it defaults to the current time of the request.	Optional	61.0

Response body for POST

Group Appointments

Connect REST API Developer Guide

Group Appointments (POST)