List all pending invites for the realm

GET

/realms/{realm_id}/invites

• Development server

See https://github.com/essential-randomness/bobaserver/issues/56 for future design intentions to return all invites.

Authorizations

• firebase

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

Responses

200

The metadata of all pending invites for the current realm.

object

invites

Array<object>

object

realm_id

required

string format: uuid

invite_url

required

string format: uri-reference

invitee_email

string format: email

own

required

boolean

issued_at

required

string format: date-time

expires_at

required

string format: date-time

label

string

Examples

{
  "invites": [
    {
      "realm_id": "76ef4cc3-1603-4278-95d7-99c59f481d2e",
      "invite_url": "https://twisted_minds.boba.social/invites/123invite_code456",
      "invitee_email": "ms.boba@bobaboard.com",
      "own": false,
      "issued_at": "2021-06-09T04:20:00Z",
      "expires_at": "2021-06-09T16:20:00Z",
      "label": "This is a test invite."
    }
  ]
}

401

User was not found in request that requires authentication.

Generic response object

object

message

string

Examples

No authentication token given.

{
  "message": "No authenticated user found."
}

Expired authentication token given.

{
  "message": "Authentication token expired."
}

403

User does not have required permissions to complete this action.

Generic response object

object

message

string

404

The realm was not found.

Generic response object

object

message

string