Skip to main content
GET
/
api
/
adm
/
invitations
Get User Invitations
curl --request GET \
  --url https://localhost:44371/api/adm/invitations \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "entries": []
}

​
Description

Queries user invitations with flexible filtering for administrative dashboards and invitation management interfaces. Results include invitation metadata such as invited user email, invitation status, expiration date, and who sent the invitation.

​
Input

  • Query Parameters: model (UserInvitationQueryRequest) — Filtering options including:
    • companyId (guid, optional) — Filter by specific company.
    • status (string, optional) — Filter by invitation status (Pending, Accepted, Expired, Cancelled).
    • email (string, optional) — Filter by invited user email address.
    • limit (int, optional) — Maximum number of records to return.
    • offset (int, optional) — Number of records to skip for pagination.

​
Output

Returns a UserInvitationQueryReponse containing matching invitations or an empty list if none found.

​
Example Request

GET /api/admin/userInvitations?companyId=3fa85f64-5717-4562-b3fc-2c963f66afa6&status=Pending
Authorization: Bearer {token}

​
Example Response

{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "invitations": [
    {
      "id": "9ef15c43-a955-6f4h-c7g3-1h6d4f0e3g9c",
      "email": "[email protected]",
      "status": "Pending",
      "expirationDate": "2025-11-05T00:00:00Z",
      "sentDate": "2025-10-27T10:00:00Z",
      "sentBy": "[email protected]"
    }
  ]
}

​
Errors

  • 400 Bad Request — Invalid query parameters or filter values.
  • 401 Unauthorized — Missing or invalid authentication token.

​
Notes

  • Empty results return success with an empty invitations array.
  • Results are paginated; use limit and offset for large datasets.
  • Invitation status values include: Pending, Accepted, Expired, Cancelled.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
Email
string | null

The email address filter applied to invitations.

​
Status
enum<string>

The optional status filter for invitations.

Available options:
AwaitingResponse,
Declined,
Accepted
​
Id
string<guid> | null

Optional identifier to filter results by a specific entity.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Response

Always returned. Check the success property in the response body to determine if the operation succeeded.

Standard response structure containing operation status and error information. Standard query response containing a collection of matching entities. Represents a paginated collection of user invitation entries.

​
success
boolean

True if the operation completed successfully; false if an error occurred.

Example:

true

​
code
enum<string>

Result code indicating the outcome of the operation.

Available options:
Unknown,
Success,
BadRequest,
Unauthorized,
NotFound,
Error
Example:

200

​
errorMessage
string | null

Human-readable error message when an error occurs.

Example:

null

​
entries
object[] | null

Collection of entities matching the query criteria.

Example:
[]