Skip to main content

Inspect invitation

POST/api/public/invitations/inspect
Public

Read more: When someone leavesSource: PublicInvitationApiController#inspect(opens in new tab)

Request body​

application/json

FieldTypeRequiredNotes
tokenstringRequiredmax 128

Response​

Success: 200

FieldTypeRequiredNotes
emailstringOptional
organizationNamestringOptional
expiresAtstring (date-time)Optional

Errors​

StatusCodeApplies to
400validation_faileda field is missing or out of rangeAny endpoint
400malformed_requestthe body cannot be readAny endpoint
400invalid_parametera path or query parameter is missing or does not convert, such as an ID that is not a UUIDAny endpoint
403access_deniedan administrator endpoint, or a missing or stale CSRF tokenAny endpoint
404not_foundno such addressAny endpoint
405method_not_allowedthe address does not take that methodAny endpoint
415unsupported_media_typethe address does not read a body of that typeAny endpoint
500internal_errora fault ReleaseFlow did not foresee; the body never carries the exception behind itAny endpoint
400output_language_invalidAccount area
400ui_locale_invalidAccount area
400invitation_invalidAccount area
400organization_slug_invalidAccount area
404invitation_not_foundAccount area
404member_not_foundAccount area
409email_already_registeredAccount area
409invitation_already_pendingAccount area
409invitation_email_unavailableAccount area
409organization_slug_takenAccount area
409member_last_administratorAccount area

Request

bash
# CSRF_HEADER and CSRF_TOKEN are the headerName and token GET /api/csrf returned.
curl -X POST "http://localhost:8080/api/public/invitations/inspect" \
-b cookies.txt -c cookies.txt \
-H "$CSRF_HEADER: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"token": "<string>"
}'

The request body is an example built from the schema; replace every placeholder.

Response

200

Example

{
  "email": "<string>",
  "organizationName": "<string>",
  "expiresAt": "<date-time>"
}