Skip to main content
GET
Get User Invite

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Response

email
string
required

E-Mail of the user to invite

company
string<uuid>
required

UUID of the company that the user is going to be part of

success_url
string
required

Success URL - the user will be redirected here after successfully completing authentication flow

failure_url
string
required

Failure URL - the user will be redirected here if either the flow was cancelled or not completed for any other reason

invite_url
string
required
read-only

Invite URL - Redirect your User to this URL for tem to complete the onboading process

expiry
string<date-time>
required
read-only

Expiry date/time of the request. After this timestamp is expired, users will have to be re-registered with a new invite

status
string
required
read-only

Current status of the User invite

id
string
first_name
string

First name of the user

last_name
string

Last name of the user