Skip to main content
GET
Get User Invite
This page documents a frozen v1 API. It receives only critical correctness or security corrections. For new integrations, use the current API and follow the linked migration guide.

Autorisierungen

Authorization
string
header
erforderlich

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

Pfadparameter

id
string<uuid>
erforderlich

Antwort

email
string
erforderlich

E-Mail of the user to invite

company
string<uuid>
erforderlich

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

success_url
string
erforderlich

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

failure_url
string
erforderlich

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

invite_url
string
erforderlich
read-only

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

expiry
string<date-time>
erforderlich
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
erforderlich
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