7 endpoints.
| Method | Path | Summary |
|---|---|---|
POST | /api/join-requests/{communityId}/bulk-invite-members | Bulk invite members via Excel (admin only) |
POST | /api/join-requests/{communityId}/invite-member | Invite a new member (admin only) |
GET | /api/join-requests/{communityId}/join-requests | Get pending join requests (admin or moderator) |
POST | /api/join-requests/{communityId}/member-requests/{requestId}/approve | Approve a join request (admin/moderator) |
POST | /api/join-requests/{communityId}/member-requests/{requestId}/reject | Reject a join request (admin/moderator) |
POST | /api/join-requests/approve-join | Approve join request via token (public route) |
POST | /api/join-requests/request-join | Request to join a public community (public route) |
POST /api/join-requests/{communityId}/bulk-invite-membersAuth: Bearer JWT required.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
communityId | path | yes | string (uuid) | — |
Request body (required) — multipart/form-data
| Field | Type | Required | Description |
|---|---|---|---|
file | string (binary) | yes | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | Bulk invite processed | — |
403 | Permission denied | — |
POST /api/join-requests/{communityId}/invite-memberAuth: Bearer JWT required.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
communityId | path | yes | string (uuid) | — |
Request body (required) — application/json
| Field | Type | Required | Description |
|---|---|---|---|
email | string (email) | yes | — |
firstName | string | no | — |
familyName | string | no | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | Member invited successfully | — |
403 | Permission denied | — |
GET /api/join-requests/{communityId}/join-requestsAuth: Bearer JWT required.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
communityId | path | yes | string (uuid) | — |
page | query | no | integer | — |
limit | query | no | integer | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | Paginated list of join requests | — |
403 | Permission denied | — |
POST /api/join-requests/{communityId}/member-requests/{requestId}/approveAuth: Bearer JWT required.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
communityId | path | yes | string (uuid) | — |
requestId | path | yes | string (uuid) | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | Join request approved | — |
403 | Permission denied | — |
POST /api/join-requests/{communityId}/member-requests/{requestId}/rejectAuth: Bearer JWT required.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
communityId | path | yes | string (uuid) | — |
requestId | path | yes | string (uuid) | — |
Request body — application/json
| Field | Type | Required | Description |
|---|---|---|---|
reason | string | no | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | Join request rejected | — |
403 | Permission denied | — |
POST /api/join-requests/approve-joinAuth: Bearer JWT required.
Request body (required) — application/json
| Field | Type | Required | Description |
|---|---|---|---|
token | string | yes | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | Join request approved | — |
POST /api/join-requests/request-joinAuth: Bearer JWT required.
Request body (required) — application/json
| Field | Type | Required | Description |
|---|---|---|---|
email | string (email) | yes | — |
communityId | string (uuid) | yes | — |
firstName | string | no | — |
familyName | string | no | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | Join request submitted | — |