{your-workspace}
with your workspace’s subdomain. Learn how to find your subdomain in Identifying your subdomain.
Headers
X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.
Path Parameters
The unique identifier (SID) of the scheduling link you want to use. You can get sid
in different ways. Visit the scheduling link page and then click on "Settings" > "Show SID". That will give you sid
. You can also get this from the response of the List all scheduling links endpoint, where it appears as the sid
property for each scheduling link in the response.
"vj5pgkh"
The unique identifier of the spot. You can get this id
from the response of the List spots for a meeting endpoint, where it appears as the id
property for each spot in the response.
"1d35e633-71b9-4ad9-b659-b034f361539b"
Response
OK - Request succeeded
Unique identifier for the spot.
"1d35e633-71b9-4ad9-b659-b034f361539b"
The spot type for the meeting.
daily
, zoom
, jitsi
, google_meet
, teams
, whereby
, in_person
, custom
, phone_call
"in_person"
Phone number for phone call spots. Only populated when spot type is "phone_call", otherwise null.
null
Custom text for custom spots. Only populated when spot type is "custom", otherwise null.
null
Location details for in-person meetings. Only populated when spot type is "in_person", otherwise null.
"123 Main St, Suite 100, City, State 12345"
Whether this spot is the default option.
true
Timestamp when the spot was created.
"2025-01-15T10:30:00Z"
Timestamp when the spot was last updated.
"2025-01-15T10:30:00Z"