Note Share Link

Get Share Link

Retrieve the current share link for a note.

  • Returns 404 if no share link exists
  • sharePassword is always null for security
get/v1/external/notes/{noteGuid}/share-link

Request

  • Base URL: https://api.tiro.ooo
  • URL: https://api.tiro.ooo/v1/external/notes/{noteGuid}/share-link
  • Auth: HTTP bearer

Path parameters

noteGuidstring required

Note GUID

Response

Share link details

shareIdstring required

Unique share link identifier

shareUrlstring uri required

Full URL for accessing the shared note

sharePasswordstring nullable

Share link password.

  • Only returned on PUT with usePassword: true
  • Always null in GET responses
hasPasswordboolean required

Whether the share link has a password

Example response

{
  "shareId": "LHr1bHvCCdVCG",
  "shareUrl": "https://tiro.ooo/s/LHr1bHvCCdVCG",
  "sharePassword": "a1b2c3d4",
  "hasPassword": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.