User-related API environment
Production user-related API docs
These pages describe the Production user-related API stack.
Use production OAuth credentials, production API base URLs, and production app URLs when following this documentation.
Need to test before going live? Switch to the Pre-live docs using the environment switcher above.
Get room invitation status
Authentication is optional. With a token, validates the current invitation or shared private link. Without a token, reports the authenticated viewer’s matched invitation. Guest responses contain only state; invitation tokens and account details are never returned.
Path Parameters
id number required
Query Parameters
token string
Optional invitation JWT or current shared private link. Omit to use the authenticated account invitation.
Responses
- 200
application/json
Schema
Example (from schema)
Example
Schema
invitationState string required
Possible values: [none, pending, accepted, expired, invalid, mismatch]
invitedAt string
hadPendingRequest boolean required
{
"invitationState": "none",
"invitedAt": "2026-10-14T10:00:00.000Z",
"hadPendingRequest": false
}
{
"invitationState": "none",
"invitedAt": "2026-10-14T10:00:00.000Z",
"hadPendingRequest": false
}
Loading...