Skip to main content

Sharing and Shortlinks

A link identifies a destination. A share grants a particular kind of access. Choose the mechanism according to the recipient and required authorization; shortening a URL does not make it private.

MechanismIntended useAccess boundary
Normal FormKiQ Web linkSend another user to a document or agreement.Sign-in and ordinary API authorization.
Folder shareGive an identified group access to one folder without a site-wide role.Share permissions and the caller's authenticated group membership.
Presigned content URLTransfer file bytes for a limited period.Possession of the unexpired URL; protect it as a credential.
ShortlinkProvide a shorter redirect to a target URL.The target's own authorization; the shortlink adds no login requirement.
PublicationMake configured content available to a public audience.The publication configuration; not a private share.

Share a folder with a group​

Obtain its indexKey from a folder listing, then create a commercial folder share:

curl -X POST "${HTTP_API_URL}/shares/folders/${FOLDER_INDEX_KEY}?siteId=${SITE_ID}" \
-H "Authorization: ${AUTHORIZATION_TOKEN}" \
-H 'Content-Type: application/json' \
-d '{"share":{"group":"ExternalReviewers","permissions":["READ"]}}'

Use GET /shares to list shares available to the caller. Pass the returned shareKey on supported folder requests; do not derive it from a document ID. Remove a share with DELETE /shares/{shareKey} when access ends. A share is not an invitation to an anonymous email recipient and does not create an identity account.

See Folder Permissions and Sharing for the complete flow and Folders for the distinction between site-wide permissions, folder entries, and shares.

curl -X POST "${HTTP_API_URL}/shortlinks?siteId=${SITE_ID}" \
-H "Authorization: ${AUTHORIZATION_TOKEN}" \
-H 'Content-Type: application/json' \
-d '{"slug":"invoice-help","targetUrl":"https://example.com/help/invoices"}'

The response contains url, the shortlink to distribute. Check Add shortlink for required permissions and supported behavior. Test the destination with a non-administrator account before sharing. Do not put bearer tokens, API keys, or presigned file URLs into a broadly distributed shortlink.

Shortlinks are redirects, not an access-revocation mechanism. Revoking a folder share or disabling a user does not necessarily invalidate a presigned URL already issued. Keep sensitive transfer URLs short-lived and avoid putting them in analytics or email content unless that exposure is intended.

Public delivery​

A public publication or webhook is deliberately different from an authenticated share. Check deployment-level public endpoint configuration, the intended audience, indexing, and expiry. A public intake webhook accepts content; it does not grant access to existing documents. See Webhooks.