getSession( )
Gets a session.
The getSession()
function returns a Promise that resolves to a session with the specified session ID.
Note: Only users with Bookings Admin permissions can view participant information in a retrieved session. You can override the permissions by setting the suppressAuth
options to true
.
Permissions
This endpoint requires the Read Bookings Calendar or the Manage Bookings permission scope. With the Read Bookings Calendar permission scope, the session participants are not returned.
Method Declaration
Copy
Method Parameters
sessionIdstringRequired
ID of the session to retrieve.
optionsOptions
An object representing the available options for getting a session.
Returns
Return Type:Promise<Session>
Was this helpful?
Yes
No