On this page

Join request management

7 endpoints.

MethodPathSummary
POST/api/communities/{communityId}/member-requests/{requestId}/remindRe-send the acceptance message to an approved applicant (admin/moderator)
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/request-joinRequest to join a community (public route). With a published join form, send multipart/form-data with the form's answers and documents in the same submission.
POST /api/communities/{communityId}/member-requests/{requestId}/remind

Re-sends the "you were accepted, come in and finish signing up" email with a FRESH seven-day password-setup link, plus an in-app notification when the applicant already has an account. Only valid while the request is APPROVED and completedAt is null.

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)—
requestIdpathyesstring (uuid)—

Responses

StatusDescriptionBody
200Reminder sent—
403Not a member, or missing permission—
404JOIN_REQUEST_NOT_FOUND / COMMUNITY_NOT_FOUND—
409JOIN_REQUEST_NOT_APPROVED or JOIN_REQUEST_ALREADY_COMPLETED—
429Too many reminders for this applicant—
502JOIN_REQUEST_REMINDER_EMAIL_FAILED—
POST /api/join-requests/{communityId}/bulk-invite-members

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—
POST /api/join-requests/{communityId}/invite-member

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—
GET /api/join-requests/{communityId}/join-requests

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)—
pagequerynointeger—
limitquerynointeger—

Responses

StatusDescriptionBody
200Paginated list of join requests—
403Permission denied—
POST /api/join-requests/{communityId}/member-requests/{requestId}/approve

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)—
requestIdpathyesstring (uuid)—

Responses

StatusDescriptionBody
200Join request approved—
403Permission denied—
POST /api/join-requests/{communityId}/member-requests/{requestId}/reject

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)—
requestIdpathyesstring (uuid)—

Request body — application/json

FieldTypeRequiredDescription
reasonstringno—

Responses

StatusDescriptionBody
200Join request rejected—
403Permission denied—
POST /api/join-requests/request-join

Multipart fields — communityId, firstName, middleName, grandfatherName, familyName, email, phone, description, acceptedTerms ('true'), formVersion, answers (JSON string), and each file as a part named document:. Total ≤ 40 MB. Errors carry a code: JOIN_FORM_REQUIRED (answers not sent), JOIN_FORM_VERSION_CHANGED, JOIN_ANSWER_INVALID, JOIN_FORM_REQUIRED_ANSWER_MISSING, JOIN_FORM_REQUIRED_DOCUMENT_MISSING, JOIN_DOCUMENT_* . Auth: Bearer JWT required.

Request body (required) — application/json

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

Responses

StatusDescriptionBody
200JOIN_REQUEST_RECEIVED — the same answer for every address—