Get the Appointment Invitee Details

An appointment invitee has information about the participant and the resources required for creating an appointment invitation URL. Use the Query() request to run Salesforce Query Language (SOQL) on the AppointmentInvitee object to retrieve the appointment invitee details, such as the service territory ID, appointment topic ID, service resource ID, and available booking start and end dates, which you need for retrieving the calendar availability for the invitation URL. You can also retrieve additional details that you need when creating an appointment, such as whether the resources are primary or required.

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

  1. Make a Query() request on the AppointmentInvitee object.

    Sample REST API Request

    1https://yourInstance.salesforce.com/services/data/vXX.X/query/?q=​SELECT+AppointmentInvitationId,Id,IsPrimaryResource,IsRequiredResource,​Name,ParticipantServiceResourceId+FROM+AppointmentInvitee+​WHERE+AppointmentInvitationId+=+'1S8x000000000oHCAQ'

    Sample Response

    1{
    2  "totalSize" : 1,
    3  "done" : true,
    4  "records" : [ {
    5    "attributes" : {
    6      "type" : "AppointmentInvitee",
    7      "url" : "/services/data/v55.0/sobjects/AppointmentInvitee/0y6x000000000pFAAQ"
    8    },
    9    "AppointmentInvitationId" : "1S8x000000000oHCAQ",
    10    "Id" : "0y6x000000000pFAAQ",
    11    "IsPrimaryResource" : true,
    12    "IsRequiredResource" : true,
    13    "Name" : "AITE-0247",
    14    "ParticipantServiceResourceId" : "0Hnx000000007d7CAA"
    15  } ]
    16}
  2. Parse the response to save the values.

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

After you fetch the appointment invitation and appointment invitee details, create a page on your website to show the calendar availability of the service resources associated with the invitation.