Sharing APIs
Supports public links and invitations by email or phone, including external recipients. Administrators can restrict external sharing. UI department invitations include descendants; this PDF only documents email/phone parameters for the invitation API, so do not invent a department parameter.
Endpoints
| Method | Endpoint | Path |
|---|---|---|
GET |
Get the list of users who can follow the file and mark the users who have followed the file | /nd/api/file/user_can_focusfile |
GET |
Get the list of users following a file | /nd/api/file/user_focusfile |
GET |
Get all sharing participants | /nd/api/share/share_participants |
GET |
Get the sharing roles that the user has permission to set for a single file | /nd/api/share/share_role_forfile |
GET |
Get a list of shared permissions | /nd/api/share/share_roles |
GET |
Get the sharing url of the file | /nd/api/share/shareurl |
POST |
remind attention | /nd/api/file/focus_file |
POST |
Delete sharing participants | /nd/api/file/remove_share_participant |
POST |
Remove someone from following | /nd/api/file/unfocus_file |
POST |
Turn off link sharing | /nd/api/share/close_link_share |
POST |
Invite people to share | /nd/api/share/invite_share |
POST |
Create link to share | /nd/api/share/open_link_share |
POST |
Set permission roles for sharing participants | /nd/api/share/set_participant_role |
POST |
Set link sharing password | /nd/api/share/set_share_password |
Integration Notes
Based on the supplied Babel API reference. Preserve exact endpoint paths and field casing. Confirm unspecified or inconsistent field types during integration rather than assuming undocumented parameters. Use the deployment's HTTPS domain and keep credentials out of public pages.