Connect APIs
Use Salesforce Scheduler Connect REST APIs to get service territories, get consolidated availability of each service resource within specified territories, and create service appointments.
Salesforce Scheduler is built on the Salesforce platform (also known as Lighting Experience). The Salesforce platform specific API rate limits apply to the Salesforce Scheduler Connect APIs. The rate limit for the Connect APIs is per user, per application, per hour limit. Salesforce Scheduler Connect APIs are better equipped to handle a large number of requests and can support the rate limit of 10000 per user, per application, per hour. For more information on Lightning platform common limits and allocations, see Connect REST API Limits.
The following is a list of Connect APIs available within the Salesforce Scheduler platform.
Use Salesforce Scheduler Connect REST APIs to get service territories and create service appointments.
- Available Territory Slots
- Engagement Channel Types
- Estimated Wait Time
- Group Appointments (POST)
- Service Appointments
- Service Territories
- Waitlists
- Waitlist Check Ins
- Waitlist Participants
To perform a POST, PATCH, or PUT request, pass query parameters or create a request body formatted in either XML or JSON.
- Available Territory Slots Input
- Assigned Resource Input
- Estimated Wait Time 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
- Waitlist Participants Input
- Work Type Input
Successful execution of a request to a Salesforce Scheduler Connect REST API resource can return a response body either in JSON or XML format.
- Available Territory Slots
- Available Territory Slots List
- Available Territory Slots Output
- Estimated Wait Time
- Engagement Channel Type List Result
- Engagement Channel Type Result
- Engagement Channel Type Output
- Extended Fields
- Group Appointments
- Group Appointments List Result
- Group Appointment Result
- Service Appointment Output
- Service Appointment Result
- Service Territories Output
- Service Territories List Result
- Service Territories Result
- Waitlist Analytics
- Waitlist Check In
- Waitlist Check In Result
- Waitlist Details
- Waitlist List Result
- Waitlist Participant Details
- Waitlist Participant Result
- Waitlist Participants Update
- Waitlist Result
- Waitlist Service Resource
- Waitlist Work Type Group
- Work Type Group Estimated Wait Time Info
See Also