On this page

7 endpoints.

MethodPathSummary
POST/api/join-requests/{communityId}/bulk-invite-membersBulk invite members via Excel (admin only)
POST/api/join-requests/{communityId}/invite-memberInvite a new member (admin only)
GET/api/join-requests/{communityId}/join-requestsGet pending join requests (admin or moderator)
POST/api/join-requests/{communityId}/member-requests/{requestId}/approveApprove a join request (admin/moderator)
POST/api/join-requests/{communityId}/member-requests/{requestId}/rejectReject a join request (admin/moderator)
POST/api/join-requests/approve-joinApprove join request via token (public route)
POST/api/join-requests/request-joinRequest to join a public community (public route)

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)

Request body (required) — multipart/form-data

FieldTypeRequiredDescription
filestring (binary)yes

Responses

StatusDescriptionBody
200Bulk invite processed
403Permission denied

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)

Request body (required) — application/json

FieldTypeRequiredDescription
emailstring (email)yes
firstNamestringno
familyNamestringno

Responses

StatusDescriptionBody
200Member invited successfully
403Permission denied

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)
pagequerynointeger
limitquerynointeger

Responses

StatusDescriptionBody
200Paginated list of join requests
403Permission denied

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)
requestIdpathyesstring (uuid)

Responses

StatusDescriptionBody
200Join request approved
403Permission denied

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)
requestIdpathyesstring (uuid)

Request bodyapplication/json

FieldTypeRequiredDescription
reasonstringno

Responses

StatusDescriptionBody
200Join request rejected
403Permission denied

Auth: Bearer JWT required.

Request body (required) — application/json

FieldTypeRequiredDescription
tokenstringyes

Responses

StatusDescriptionBody
200Join request approved

Auth: Bearer JWT required.

Request body (required) — application/json

FieldTypeRequiredDescription
emailstring (email)yes
communityIdstring (uuid)yes
firstNamestringno
familyNamestringno

Responses

StatusDescriptionBody
200Join request submitted