nexlink/docs/api/invite.md
2025-12-29 02:03:47 +01:00

52 lines
835 B
Markdown

## GET /api/v1/invite/{id}
Returns an invite with id = {id}
### Response:
```json
{
"id": "string",
"communityId": "string",
"valid": "boolean",
"unlimitedInvites": "boolean",
"hasExpiration": "boolean",
"totalInvites": "number",
"remainingInvites": "number",
"creationDate": "number",
"expirationDate": "number"
}
```
## DELETE /api/v1/invite/{id}
_Requires an authorization header_
Removes an invite with id = {id}
### Response:
```json
{
"id": "string",
"communityId": "string"
}
```
## GET /api/v1/invite/{id}/accept
_Requires an authorization header_
Accepts an invite and joins user to a community with id = {id}
### Response:
```json
{
"id": "string",
"userId": "string",
"userName": "string",
"communityId": "string",
"communityName": "string"
}
```