Salesforce Scheduler Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introduction to Salesforce Scheduler
Set Up Salesforce Scheduler
Salesforce Scheduler Data Model Overview
Salesforce Scheduler Standard Objects
Salesforce Scheduler Custom Objects
Salesforce Scheduler Platform Events
Salesforce Scheduler Metadata API Types
Authenticate Salesforce Scheduler APIs
Translate SOQL Query Results
Salesforce Scheduler Business APIs
REST APIs
Connect APIs
Resources
Connect REST API Request Bodies
Available Territory Slots Input
Assigned Resource Input
Extended Fields Input
Group Appointments Input
Lead Input
Service Appointments Create Input
Service Appointment Update Input
Service Appointment Input
Skill Requirement Input
Waitlist Check In Input
Work Type Input
Connect REST API Response Bodies
Error Codes and Responses
Salesforce Scheduler Apex Classes
Build Custom Appointment Booking Experiences Using Salesforce Scheduler APIs
Integrate Salesforce Scheduler with External Calendars
PDF

Group Appointments Input

Input representation of the criteria to filter and retrieve group appointments.
JSON example
{
  "startTime": "2024-01-23T00:00:00.000Z",
  "endTime": "2024-02-28T00:00:00.000Z",
  "filterByWorkTypes": [
    "08qRM00000003fkYAA"
  ],
  "filterByResources": [
    "0HnB0000000TO8gKAK"
  ],
  "filterByTerritories": [
    "0HhRM00000003OZ0AY"
  ],
  "filterByParentRecords": [
    "001B000000qAUAWIA4"
  ],
  "filterByEngagementChannelTypes": [
    "0eFRM00000000Bv2AI"
  ],
  "extendedFieldsToQuery": [
    "subject",
    "description"
  ]
}
Properties
Name Type Description Required or Optional Available Version
endTime String Latest end time for the group appointments to be retrieved. Optional 61.0
exclude​Associated​Appts 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
extended​FieldsToQuery String[] List of the extended custom fields to fetch in the output. Optional 61.0
filterBy​Engagement​ChannelTypes String[] ID of the engagement channel type record. Group appointments are filtered based on the selected engagement channel type. Optional 61.0
filterBy​ParentRecords String[] The ID of the associated parent record. Optional 61.0
filterBy​Resources String[] List of the group appointments where all the given resources are present. Optional 61.0
filterBy​Territories String[] List of IDs of the service territories where the requested work is performed. Optional 61.0
filterBy​WorkTypeGroups String[] IDs of the work type groups containing the work types that are being performed. Optional 61.0
filterBy​WorkTypes 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