---
schema_version: "1"
id: 2ca6dccf9c9d747c9313649b0b37a5f2ae10e17c2e77b82b3c1b7f0f96a2a2d9
title: Get the Appointment Invitation Details
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/service-cloud/salesforce-scheduler-dev-guide/guides/salesforce-scheduler/uc10-get-appointment-invitation-details.md
canonical_url: https://developer.salesforce.com/docs/service/salesforce-scheduler-dev-guide/guide/uc10-get-appointment-invitation-details.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: 3f6b49c316515bf8c28d617b32ac97ec820dbc9b9bf30591eaac9639fdd8e87b
products:
  - Salesforce Scheduler Developer Guide
  - Service Cloud Developer Content
---

# 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](https://developer.salesforce.com/docs/atlas.en-us.salesforce_scheduler_developer_guide.meta/salesforce_scheduler_developer_guide/sforce_api_objects_appointmentinvitation.htm).

1.  Make a [`Query()`](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_query.htm) request on the AppointmentInvitation object.

    **Sample REST API Request**

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

    ```nolang
    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**

    ```nolang
    {
      "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"
      } ]
    }
    ```

2.  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.