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

​
Description

This endpoint retrieves all pending invitations for the specified tenant, including invitation status and creation timestamps.

​
Input

  • tenantId (path, required): Identifier of the tenant whose invitations are requested
  • cancellationToken (optional): Token to cancel the asynchronous operation

​
Output

Returns a Result<ICollection<UserInvitationModel>> containing tenant invitations.

​
Examples

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

​
Errors

  • 400 Bad Request: Invalid tenant identifier
  • 401 Unauthorized: Authentication credentials are missing or invalid
  • 403 Forbidden: User lacks permission to view invitations
  • 404 Not Found: No invitations exist for the tenant
  • 500 Internal Server Error: Unexpected server error occurred

​
Notes

  • Only pending invitations are returned
  • Accepted and declined invitations are not included

Path Parameters

​
tenantId
integer<int64>
required

Identifier of the tenant whose invitations are requested.

Response

Invitations retrieved 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[] | null

The result value returned when the operation is successful.