Get invite by code

Returns invite details for the given code. This is a public endpoint that does not require authentication.

GET /api/invites/{code}

Get invite by code

cURL

curl --request GET \
  --url http://localhost:8091/api/invites/{code}

200

{
  "data": {
    "id": "<string>",
    "code": "<string>",
    "serverId": "<string>",
    "createdBy": "<string>",
    "useCount": 123,
    "active": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z",
    "maxUses": 123,
    "server": {
      "id": "<string>",
      "name": "<string>",
      "createdBy": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "iconPath": "<string>",
      "role": "<string>",
      "memberCount": 123
    }
  }
}

Path Parameters

code · string · required

Invite code

Response

200

application/json

Invite details

data · object

Show child attributes