Get the Appointment Invitation Details

An appointment invitation has information that users can use for booking appointments. Use the Query() request to run Salesforce Query Language (SOQL) on the AppointmentInvitation object to retrieve the appointment invitation details, such as the appointment invitation ID, appointment topic ID (work type group ID), appointment topic type, service territory ID, availability start date, and availability end date.

For a complete list of AppointmentInvitation object fields, see AppointmentInvitation.

Make a Query() request on the AppointmentInvitation object.

Sample REST API Request

To ensure that the invitation URL is active, set the value of the IsActive query parameter to true.

Note

https://yourInstance.salesforce.com//services/data/vXX.X/query/?q=SELECT+AppointmentTopicId,AppointmentTopicType,BookingEndDate,BookingStartDate,Id,ServiceTerritoryId+FROM+AppointmentInvitation+WHERE+InvitationIdentifier+=+'f482d103-4792-40ac-864a-57db0c13161b'+AND+IsActive+=+true

Sample Response

{
  "totalSize" : 1,
  "done" : true,
  "records" : [ {
    "attributes" : {
      "type" : "AppointmentInvitation",
      "url" : "/services/data/v55.0/sobjects/AppointmentInvitation/1S8x000000000oHCAQ"
    },
    "AppointmentTopicId" : "0VSx00000002Uh4GAE",
    "AppointmentTopicType" : "WorkTypeGroup",
    "BookingEndDate" : "2022-06-30",
    "BookingStartDate" : "2022-06-14",
    "Id" : "1S8x000000000oHCAQ",
    "ServiceTerritoryId" : "0Hhx00000002LzGCAU"
  } ]
}

Parse the response to save the values.
You need these values to fetch the invitation availability time slots.

After you fetch the invitation details, retrieve the service resources associated with the invitation URL.

Developer Centers

Salesforce Platform

Industries

Resources

Developer Tools

Build Skills

Extend Salesforce

Stay Up To Date

Community

Salesforce Scheduler Developer Guide

No Results

Get the Appointment Invitation Details