API Docs / Schemas / InvitationDetailsResponse

InvitationDetailsResponse

Response containing details about an invitation

Properties

Name Type Description
tenantNamestring

The name of the tenant/practice

The name of the tenant/practice

tenantCodestring

The code of the tenant

The code of the tenant

userEmailstring

The email address of the invited user

The email address of the invited user

tokenstring

The invitation token

The invitation token

statusenum

Created Invited Active Disabled Declined Deleted

Created Invited Active Disabled Declined Deleted

expiresOnstring

When the invitation expires

When the invitation expires

acceptedAtstring

When the invitation was accepted

When the invitation was accepted

declinedAtstring

When the invitation was declined

When the invitation was declined

isExpiredboolean

Whether the invitation has expired

Whether the invitation has expired

JSON Example

{
  "tenantName": "string",
  "tenantCode": "string",
  "userEmail": "string",
  "token": "string",
  "status": "Created"
}