curl --request PUT \
  --url https://api.tiro.ooo/v1/external/notes/{noteGuid}/share-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "usePassword": true
}
'

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

{
  "error": {
    "code": 404018,
    "errorType": "not_found",
    "message": "No team found for user #217",
    "detail": null
  }
}

{
  "error": {
    "code": 403003,
    "errorType": "forbidden",
    "message": "Link sharing is not allowed for this team"
  }
}

{
  "error": {
    "code": 404018,
    "errorType": "not_found",
    "message": "No team found for user #217",
    "detail": null
  }
}

Upsert Share Link

Create or update a share link for a note.

If no link exists, creates a new one. If it already exists, updates password settings.
An empty body {} creates a link without a password.

`usePassword` behavior

`usePassword`	No existing link	Existing link
`null` (omit)	Create without password	Keep current state
`true`	Create with password	(Re)generate password
`false`	Create without password	Remove password

sharePassword is only included when usePassword: true. Store it immediately — it cannot be retrieved later.

PUT

external

notes

{noteGuid}

share-link

curl --request PUT \
  --url https://api.tiro.ooo/v1/external/notes/{noteGuid}/share-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "usePassword": true
}
'

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

{
  "error": {
    "code": 404018,
    "errorType": "not_found",
    "message": "No team found for user #217",
    "detail": null
  }
}

{
  "error": {
    "code": 403003,
    "errorType": "forbidden",
    "message": "Link sharing is not allowed for this team"
  }
}

{
  "error": {
    "code": 404018,
    "errorType": "not_found",
    "message": "No team found for user #217",
    "detail": null
  }
}

인증

Authorization

string

header

필수

API key in format {id}.{secret}.

The notes an endpoint returns depend on the key type. A user key reaches the notes that user can see in the app, including notes in their own private folders. A system key (workspace or organization, no user identity) reaches only notes that sit in a folder shared with all workspace members. Notes in a private folder, in a folder shared with only some members, or in no folder at all fall outside a system key's read scope, and scopes do not widen that boundary.

List and search endpoints drop out-of-scope notes from the response without an error. Single-note reads and their sub-resources return 404, the same response as a deleted note. See What notes a system key reads.

경로 매개변수

noteGuid

string

필수

Note GUID

본문

application/json

usePassword

boolean | null

Controls the share link password.

true — Generate password (regenerate if one exists)
false — Remove password (or create without one)
null / omitted — Keep current password state

응답

Share link created or updated

Unique share link identifier

예시:

"LHr1bHvCCdVCG"

Full URL for accessing the shared note

예시:

"https://tiro.ooo/s/LHr1bHvCCdVCG"

hasPassword

boolean

필수

Whether the share link has a password

예시:

true

Share link password.

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

예시:

"a1b2c3d4"

Get Share Link

Delete Share Link

홈

시작하기

API

웹훅

MCP

CLI

개발자 리소스

Upsert Share Link

`usePassword` behavior

인증

경로 매개변수

본문

응답