Get invitation

GET 
/invitation/:invitationId

Gets information about the invitation.

Request

Path Parameters

invitationId stringrequired
The invitation ID.
Example: invite-100001

Responses

200

OK

application/json

Schema

Schema

code int32

The response code.

data

object

The invitation information.

email string

The email address to receive the invitation.

expiredTime int64

The expiration time of the invitation.

id string

The invitation ID.

roleId string

The ID of the role to which the subaccount will be assigned.

status string

Possible values: [PENDING, ACCEPTED, EXPIRED]

The invitation status.

msg string

The response message.

Example (from schema)

{
  "code": 0,
  "data": {
    "email": "[email protected]",
    "expiredTime": 1685510869834,
    "id": "invite-100001",
    "roleId": "role-100001",
    "status": "PENDING"
  },
  "msg": "string"
}

Loading...