On this page

5 endpoints.

MethodPathSummary
GET/api/communities/{communityId}/join-requests/reviewList join requests by status, with search and per-status counts
GET/api/communities/{communityId}/join-requests/review/{requestId}One request with the form it answered, its answers and its documents
GET/api/communities/{communityId}/join-requests/review/{requestId}/attachments/{attachmentId}Stream one applicant document to a reviewer (recorded; never cached)
POST/api/communities/{communityId}/join-requests/review/bulkApprove or reject up to 50 account-first requests, with a result per row
GET/api/communities/{communityId}/join-requests/review/export.csvCSV of the requests in one status (and search), answers as labels, formula-guarded

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring—
statusquerynoenum: PENDING, APPROVED, REJECTED, WITHDRAWN, EXPIRED—
qquerynostring—
pagequerynointeger—
limitquerynointeger—

Responses

StatusDescriptionBody
200items, total, page, limit, counts, currentFormVersion—
403Missing users:manage / users:moderate—

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring—
requestIdpathyesstring—

Responses

StatusDescriptionBody
200JoinReviewDetail—
404JOIN_REQUEST_NOT_FOUND—

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring—
requestIdpathyesstring—
attachmentIdpathyesstring—

Responses

StatusDescriptionBody
200The file, with its detected content type—
404JOIN_DOCUMENT_NOT_FOUND—
410JOIN_DOCUMENT_DELETED — removed under the retention policy—

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring—

Responses

StatusDescriptionBody
200results: [{ requestId, ok, code? }]—
400JOIN_REVIEW_BULK_INVALID—

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring—
statusquerynostring—
qquerynostringThe list's search — the file holds what the reviewer sees

Responses

StatusDescriptionBody
200text/csv (UTF-8 with BOM)—