Get an invite's realm and status.

GET

/realms/{realm_id}/invites/{nonce}

• Development server

Parameters

Path Parameters

realm_id

required

string format: uuid

The id of the realm.

Examples

the twisted-minds realm id

76ef4cc3-1603-4278-95d7-99c59f481d2e

nonce

required

string

The invite code.

Examples

the invite code.

123invite_code456

Responses

200

The realm amd status of the requested invite.

object

realm_id

required

string format: uuid

realm_slug

required

string

invite_status

required

string

Allowed values: pending used expired

requires_email

required

boolean

Examples

{
  "realm_id": "76ef4cc3-1603-4278-95d7-99c59f481d2e",
  "realm_slug": "twisted-minds",
  "invite_status": "pending",
  "requires_email": true
}

404

The invite with the given code was not found.

Generic response object

object

message

string