--- title: WSD Reservation Invitees API description: The Workplace Service Delivery \(WSD\) Reservation Invitees API provides endpoints to add invitees to reservations, fetch invitees of a reservation, and reassign invitees of a reservation.Retrieves details about the invitees associated with a specified reservation.Reassigns the specified invitees from one reservation to another.Adds the specified invitees to a specified reservation. locale: en-US canonical_url: https://www.servicenow.com/docs/r/australia/api-reference/rest-apis/wsd\_reservation\_invitees-api.html release: australia product: REST APIs classification: rest-apis topic_type: concept last_updated: "2026-03-12" reading_time_minutes: 11 breadcrumb: [REST API reference, API reference, API implementation and reference] --- # WSD Reservation Invitees API The Workplace Service Delivery \(WSD\) Reservation Invitees API provides endpoints to add invitees to reservations, fetch invitees of a reservation, and reassign invitees of a reservation. To access this API, the caller must have the sn\_wsd\_core.workplace\_user role and the Workplace Reservation Management \(sn\_wsd\_rsv\) plugin must be activated. This API runs in the `sn_wsd_rsv` namespace. For additional information on Workplace Reservation Management, see [Workplace Reservation Management](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/employee-service-management/workplace-rsv-mgmt-feat.md). **Parent Topic:**[REST API reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/api-rest.md) ## WSD Reservation Invitees - GET /api/sn\_wsd\_rsv/wsd\_reservation\_invitees/reservation/\{sys\_id\} Retrieves details about the invitees associated with a specified reservation. ### URL format Versioned URL: `/api/sn_wsd_rsv/{api_version}/wsd_reservation_invitees/reservation/{sys_id}` Default URL: `/api/sn_wsd_rsv/reservation/{sys_id}` **Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md). ### Supported request parameters
| Name | Description |
|---|---|
| api\_version | Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String |
| sys\_id | Sys\_id of the reservation for which to return the invitee details.Data type: String |
| Header | Description |
|---|---|
| Accept | Data format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json** |
| Name | Description |
|---|---|
| result | Return results for the invitees associated with the specified reservation.Data type: Object ``` { "result": { "invitees": [Array], "reservationId": "String", "reservationSubType": "String", "success": Boolean } } ``` |
| result.invitees | Details about the invitees associated with the reservation.Data type: Array of Objects ``` "invitees": [ { "email": "String", "firstName": "String", "inviteeId": "String", "inviteState": {Object}, "inviteeType": "String", "isVIP": Boolean, "isWifiRequired": Boolean, "isParkingRequired": Boolean, "lastName": "String", "licensePlate": "String", "location": {Object}, "name": "String", "org": "String", "parkingType": "String", "phoneNumber": "String", "privateNotes": "String", "reservationId": "String", "reservationInviteeId": "String", "title": "String", "visitorType": "String" } ] ``` |
| result.invitees.email | Email address of the invitee. Data type: String |
| result.invitees.firstName | First name of the invitee.Data type: String |
| result.invitees.inviteeId | Sys\_id of the employee's user record. Data type: String Table: User \[sys\_user\] |
| result.invitees.inviteState | Details about the current state of the invitee for the reservation.Data type: Object ``` "inviteState": { "displayValue": "String", "value": "String" } ``` |
| result.invitees.inviteState.displayValue | Display value for the invitee state, such as New or Removed.Data type: String |
| result.invitees.inviteState.value | Internal value for the invitee state.Data type: String |
| result.invitees.inviteeType | Type of invitee. Valid values: \(case-sensitive\) - employee - visitor Data type: String |
| result.invitees.isVIP | Flag that indicates whether the invitee is classified as a VIP.Valid values: - true: Invitee is a VIP. - false: Invitee isn't a VIP. Data type: Boolean |
| result.invitees.isWifiRequired | Flag that indicates whether the WIFI password should be provided to the visitor upon entry.Valid values: - true: Provide WIFI password. - false: Don't provide WIFI password. Data type: Boolean |
| result.invitees.isParkingRequired | Flag that indicates whether the invitee requires parking.Valid values: - true: Parking needed. - false: Parking isn't needed. Data type: Boolean |
| result.invitees.lastName | Last name of the invitee.Data type: String |
| result.invitees.licensePlate | License plate of the invitee.Data type: String |
| result.invitees.location | Details about the workplace location of the invitee.Data type: Object ``` "location": { "displayName": "String", "sysId": "String" } ``` |
| result.invitees.location.displayName | Display name of the invitee's workplace location, such as Dublin.Data type: String |
| result.invitees.location.sysId | Sys\_id of the invitee workplace location.Data type: String Table: Workplace Location \[sn\_wsd\_core\_worplace\_location\] |
| result.invitees.name | Name of the invitee.Data type: String |
| result.invitees.org | Organization of the invitee.Data type: String |
| result.invitees.parkingType | Type of parking required for invitee.Valid values: \(case-sensitive\) - ev\_parking - none - normal\_parking - van\_accessible\_parking Data type: String |
| result.invitees.phoneNumber | Phone number of the invitee.Data type: String |
| result.invitees.privateNotes | Any additional notes provided by the invitee.Data type: String |
| result.invitees.reservationId | Sys\_id of the reservation to which the invitee is associated.Data type: String Table: Workplace Reservation \[sn\_wsd\_rsv\_reservation\] |
| result.invitees.reservationInviteeId | Sys\_id of the reservation invitee for visitor. Data type: String Table: Reservation Invitee \[sn\_wsd\_rsv\_m2m\_reservation\_invitee\] |
| result.invitees.title | Title of the invitee.Data type: String |
| result.invitees.visitorType | Type of invitee.Valid values: \(case-sensitive\) - client - contractor - friend\_family - others Data type: String |
| result.reservationId | Sys\_id of the reservation to which the invitee is associated.Data type: String Table: Workplace Reservation \[sn\_wsd\_rsv\_reservation\] |
| result.reservationSubType | Sub-type of the reservation record, such as single or multi-child.Data type: String |
| result.success | Flag that indicates whether the call was successful.Possible values: - true: Endpoint call was successful. - false: Endpoint call failed. Data type: Boolean |
| Name | Description |
|---|---|
| api\_version | Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String |
| Name | Description |
|---|---|
| reservationId | Required. Sys\_id of the reservation for which to reassign the invitees.Data type: String Table: Workplace Reservation \[sn\_wsd\_rsv\_reservation\] |
| reservationInvitees | List of invitees to reassign to the reservation identified in the **reservationId** parameter.This removes the specified invitees from an earlier reservation in which they were present as per the reservation invitee table and moves them to this reservation. Data type: Array of Strings Table: Reservation Invitee \[sn\_wsd\_rsv\_m2m\_reservation\_invitee\] |
| Header | Description |
|---|---|
| Accept | Data format of the request body. Supported types: **application/json**, **application/xml** or, **text/xml**. Default: **application/json** |
| Content-Type | Data format of the request body. Only supports **application/json**. |
| Name | Description |
|---|---|
| result | Details about the invitee reassignment.Data type: Object ``` "result": { "reservationInviteeIds": [Array], "success": Boolean } ``` |
| result.reservationInviteeIds | List of sys\_ids of the reservation invitees that were re-assigned to the specified reservation.Data type: Array of Strings |
| result.success | Flag that indicates whether the invitees were reassigned to the reservation.Possible values: - true: Invitees were successfully reassigned. - false: Invitees weren't reassigned. Data type: Boolean |
| Name | Description |
|---|---|
| api\_version | Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String |
| Name | Description |
|---|---|
| invitees | List of invitees to add to the specified reservation.Data type: Object ``` "invitees": [ { "email": "String", "firstName": "String", "inviteeId": "String", "inviteeType": "String", "isVIP": Boolean, "isWifiRequired": Boolean, "lastName": "String", "licensePlate": "String", "org": "String", "parkingType": "String", "phone": "String", "privateNotes": "String", "title": "String", "visitorType": "String" } ] ``` |
| invitees.email | Required when **inviteeType** is "visitor". Email address of the invitee. Data type: String |
| invitees.firstName | First name of the invitee.Data type: String |
| invitees.inviteeId | Required if **inviteType** is "employee". Sys\_id of the employee's user record. Data type: String Table: User \[sys\_user\] |
| invitees.inviteeType | Required. Type of invitee. Valid values: \(case-sensitive\) - employee - visitor Data type: String |
| invitees.isVIP | Flag that indicates whether the invitee is classified as a VIP.Valid values: - true: Invitee is a VIP. - false: Invitee isn't a VIP. Data type: Boolean |
| invitees.isWifiRequired | Flag that indicates whether the WIFI password should be provided to the visitor upon entry.Valid values: - true: Provide WIFI password. - false: Don't provide WIFI password. Data type: Boolean |
| invitees.lastName | Last name of the invitee.Data type: String |
| invitees.licensePlate | License plate of the invitee.Data type: String |
| invitees.org | Organization of the invitee.Data type: String |
| invitees.parkingType | Type of parking required for invitee.Valid values: \(case-sensitive\) - ev\_parking - none - normal\_parking - van\_accessible\_parking Data type: String |
| invitees.phone | Phone number of the invitee.Data type: String |
| invitees.privateNotes | Any additional notes provided by the invitee.Data type: String |
| invitees.title | Title of the invitee.Data type: String |
| invitees.visitorType | Type of invitee.Valid values: \(case-sensitive\) - client - contractor - friend\_family - others Data type: String |
| reservationId | Required. Sys\_id of the reservation for which to add the invitees. Data type: String Table: Workplace Reservations \[sn\_wsd\_rsv\_reservation\] |
| Header | Description |
|---|---|
| Accept | Data format of the request body. Supported types: **application/json**, **application/xml** or, **text/xml**. Default: **application/json** |
| Content-Type | Data format of the request body. Only supports **application/json**. |
| Name | Description |
|---|---|
| result | Result of adding the invitees to the reservation.Data type: Object ``` "result": { "reservationId": "String", "success": Boolean } ``` |
| result.reservationId | Sys\_id of the reservation to which the invitee was added.Data type: String |
| result.success | Flag that indicates whether the invitees were added to the reservation.Possible values: - true: Invitees were successfully added. - false: Invitees were not added. Data type: Boolean |