Getting Started
Webhooks
Template Based Documents
External Viewers
Reserve Note GUID
Copy
curl --request POST \
--url https://api.tiro.ooo/v1/external/notes/guids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "Weekly Team Standup"
}
'Copy
{
"guid": "x6DjzdpXqkEcU",
"title": "Weekly Team Standup",
"expiresAt": "2024-01-15T11:30:00Z",
"createdAt": "2024-01-15T10:30:00Z"
}Reserve Note GUID
Reserve a note GUID for later use in note creation. This allows you to:
- Get a GUID before actually creating the note
- Use the reserved GUID when creating a note with POST /v1/notes (internal API)
- Reservation expires after 1 hour if not used
Use case: When you need to know the note GUID before the note content is ready, such as setting up webhooks or references in advance.
POST
/
v1
/
external
/
notes
/
guids
Reserve Note GUID
Copy
curl --request POST \
--url https://api.tiro.ooo/v1/external/notes/guids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "Weekly Team Standup"
}
'Copy
{
"guid": "x6DjzdpXqkEcU",
"title": "Weekly Team Standup",
"expiresAt": "2024-01-15T11:30:00Z",
"createdAt": "2024-01-15T10:30:00Z"
}Authorizations
API key in format {id}.{secret}
Body
application/json
Optional parameters for the note reservation
If provided, sets the title for the note to be created.
Maximum string length:
100Example:
"Weekly Team Standup"
Response
Note GUID successfully reserved
Reserved note GUID that can be used for note creation
Example:
"x6DjzdpXqkEcU"
ISO-8601 timestamp when the reservation expires (1 hour from creation)
Example:
"2024-01-15T11:30:00Z"
ISO-8601 timestamp when the reservation was created
Example:
"2024-01-15T10:30:00Z"
Title of the note if provided during reservation
Example:
"Weekly Team Standup"
⌘I