Skip to main content
POST
Start a Calendar Connection

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Body

application/json
user_id
string<uuid>
required
provider
enum<string>
required
Available options:
google,
outlook
return_path
string
default:/availability
confirm
boolean

Response

Successful response.

success
enum<boolean>
required
Available options:
true
provider
enum<string>
required
Available options:
google,
outlook
user_id
string<uuid>
required
connect_url
string<uri>
required
expires_at
string
required
connection_request_id
string
required
next
string
required
Last modified on September 8, 2026