resource_type'GroupLink' required
The resource type of the group link
namestring required
The name of the group link
emailstring email nullable required
The email to the person who should have access.
phonestring nullable required
The phone number of the person who should have access. Only US, Canadian and Puerto Rican numbers in
the format +11234567890 (E.164) are accepted.
last_used_atstring date-time nullable required
When the group link was last used.
link_enabledboolean required
Will generate a link that can be used for access.
quick_response_code_type'online' | 'offline' | 'null' nullable required
Will generate a QR code (optionally offline capable) that can be scanned with compatible Kisi readers. Will be sent as part of the access link email, if an email address is provided. Will never be sent as part of SMS.
valid_fromstring date-time nullable required
valid_untilstring date-time nullable required
created_atstring date-time required
When the group link was created
updated_atstring date-time required
When the group link was updated
group_idinteger required
The group ID of the group link
created_by_type'null' | 'User' | 'MarketplaceInstallation' nullable required
The created_by type of the group link
created_by_idinteger nullable required
The created_by ID of the group link
issued_by_idinteger nullable required
The issued_by ID of the group link
secretstring nullable required
The secret value used for authentication.
quick_response_code_tokenstring nullable required
The quick response code token.
quick_response_code_imagestring nullable required
The quick response code token rendered as a Base64-encoded PNG image.