Skip to main content
GET
/
tenant
/
{tenantId}
/
admin
/
user
/
invitation
/
active
CheckActiveInvitationByEmail
curl --request GET \
  --url https://api.example.com/tenant/{tenantId}/admin/user/invitation/active
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

This endpoint checks whether any active invitations exist for a specific email address within the tenant context.

​
Input

  • tenantId (path, required): Identifier of the tenant to scope the invitation search
  • email (query, required): Email address to query for active invitations
  • cancellationToken (optional): Token to cancel the asynchronous operation

​
Output

Returns a Result<CheckActiveInvitationResponse> indicating whether active invitations exist.

​
Examples

Request: 
GET /api/tenant/1024/users/[email protected]
Response (200 OK): 
{
  "data": {
    "anyActive": true
  },
  "isSuccess": true
}

​
Errors

  • 400 Bad Request: Invalid email format
  • 401 Unauthorized: Authentication credentials are missing or invalid
  • 403 Forbidden: User lacks permission to inspect invitations
  • 500 Internal Server Error: Unexpected server error occurred

​
Notes

  • Only returns status for pending invitations, not accepted or declined
  • Useful for preventing duplicate invitations

Path Parameters

​
tenantId
integer<int64>
required

Identifier of the tenant to scope the invitation search.

Query Parameters

​
email
string

Email address used to query for active invitations.

Response

Invitation status evaluated successfully.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.

Example:
{ "anyActive": true }