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

​
Description

This endpoint retrieves invitation details for a specific email address, including invitation status and creation timestamp.

​
Input

  • email (query, required): Email address associated with the user invitation
  • cancellationToken (optional): Token to cancel the asynchronous operation

​
Output

Returns a Result<UserInvitationModel> containing invitation details including status and timestamps.

​
Examples

Request: 
GET /api/tenant/users/[email protected]
Response (200 OK): 
{
  "data": {
    "id": 9001,
    "email": "[email protected]",
    "status": "Pending",
    "createdAt": "2024-03-15T12:30:00Z"
  },
  "isSuccess": true
}

​
Errors

  • 400 Bad Request: Invalid email address format
  • 401 Unauthorized: Authentication credentials are missing or invalid
  • 403 Forbidden: User lacks permission to query invitations
  • 404 Not Found: No invitation exists for the supplied email address
  • 500 Internal Server Error: Unexpected server error occurred during retrieval

​
Notes

  • Only returns active/pending invitations
  • Accepted or declined invitations are not returned
  • Does not require tenant identifier in request
  • Useful for checking invitation status before acceptance

Query Parameters

​
email
string

Email address associated with the user invitation.

Response

Invitation located and returned 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:
{
  "id": 9001,
  "email": "[email protected]",
  "status": "Pending",
  "createdAt": "2024-03-15T12:30:00Z"
}