v1

latestOpenAPI 3.1.02026-07-226875162.5 KB

Note

List Workspace Notes

List the notes in a workspace with cursor-based pagination. This is the workspace-scoped successor to the deprecated GET /v1/external/notes.

The API key must be scoped to the workspace in the path; a key bound to a different workspace returns 403.

Use folderId to scope the listing to a specific folder (recursive, including descendant folders). Combine with createdAtFrom / createdAtTo to bound the result by creation time.

get/v1/external/workspaces/{workspaceGuid}/notes

Path parameters

workspaceGuidstring required

Workspace GUID. Obtain it from GET /v1/external/workspaces.

Query parameters

cursorstring

Cursor for the next page

sizeinteger

Page size (default 100, max 200)

keywordstring

Optional keyword for a shallow full-text search. When present, results are reordered by relevance and bounded by what the search index returns; nextCursor is always null in this mode (single page). Combine with folderId and createdAtFrom / createdAtTo to narrow the results. For deep search that also returns note documents, use POST /v1/external/workspaces/{workspaceGuid}/notes/search instead. Requires a user-scoped API key.

folderIdstring

Restrict to notes inside a specific folder. Includes descendant folders (recursive). The folder must belong to this workspace.

createdAtFromstring date-time

ISO 8601 datetime — return only notes with createdAt >= this value.

createdAtTostring date-time

ISO 8601 datetime — return only notes with createdAt < this value.

Response

List of notes in the workspace

nextCursorstring nullable required

Cursor for next page, null if last page

Example response

{
  "content": [
    {
      "guid": "note-guid-123",
      "workspaceGuid": "ws_a1b2c3d4",
      "title": "Meeting notes",
      "createdAt": "2025-07-20T10:00:00Z",
      "updatedAt": "2025-07-20T11:10:00Z",
      "sourceType": "live-voice",
      "recordingStartAt": "2025-07-20T10:00:10Z",
      "recordingEndAt": "2025-07-20T11:00:10Z",
      "recordingDurationSeconds": 3600,
      "transcribeLocale": "en_US",
      "translateLocale": "ko_KR",
      "webUrl": "https://tiro.ooo/n/123",
      "collaborators": [
        {
          "guid": "user-guid-123",
          "name": "John Doe",
          "email": "john@example.com",
          "role": "OWNER"
        }
      ],
      "participants": [
        {
          "name": "Alice Kim",
          "email": "alice@example.com"
        }
      ],
      "documents": [
        {
          "id": 456,
          "noteGuid": "note-abc123-def456",
          "note": {
            "guid": "note-abc123-def456",
            "webUrl": "https://tiro.ooo/n/xQ8YKnZUPGHNB"
          },
          "template": {
            "id": 1,
            "title": "영업 보고서"
          },
          "locale": "ko_KR",
          "sections": [
            {
              "content": {
                "type": "text/plain",
                "content": "Hello everyone, welcome to today's meeting..."
              },
              "createdAt": "2025-10-20T12:35:26Z"
            }
          ],
          "createdAt": "2025-10-20T12:35:26Z",
          "updatedAt": "2025-10-20T13:45:30Z"
        }
      ]
    }
  ],
  "nextCursor": "opaque-cursor-string"
}