GET/users/{userId}/ainote/notes

AiNote ユーザーのノートのリストを取得する。
startTime と endTime の間隔は、最大で 1 年指定できる。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

ainote
ainote.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/ainote/notes

Path Parameters

ParameterTypeDescription
userId string 

ユーザー ID


required 

Query Parameters

ParameterTypeDescription
cursor string 

リストのカーソル値 (URL エンコードする)

 
orderBy string 

ソート
ソート対象や順番は空白 (%20) で区分
例) createdTime%20desc

  • ソート対象
    • createdTime, updatedTime
  • 順番
    • asc : 昇順
    • desc : 降順

default : createdTime%20desc 
count integer 

取得数


default : 20
minimum : 1
maximum : 50 
startTime string 

照会の開始日時 (形式: YYYY-MM-DDThh:mm:ssTZD)

  • URL エンコードする。(+ → %2B)
  • 既定値は endTime から 1 年前

example : 2025-03-01T10:00:00%2B09:00 
endTime string 

照会の終了日時 (形式: YYYY-MM-DDThh:mm:ssTZD)

  • URL エンコードする。(+ → %2B)
  • 既定値は現在時刻

example : 2025-03-01T10:00:00%2B09:00 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
notes array (Note) 
 
responseMetaData object (responseMetaData) 
 

Note

PropertyTypeDescription
noteId string 

ノート ID

 
workspaceId string 

ワークスペース ID

 
userId string 

ノート作成者のユーザー ID

 
createdTime string 

ノートの作成日時 (YYYY-MM-DDThh:mm:ssTZD)

 
updatedTime string 

ノートの更新日時 (YYYY-MM-DDThh:mm:ssTZD)

 
title string 

ノート名

 
recognitionLanguage string 

認識言語

  • ja: 日本語
  • ko: 韓国語
  • en: 英語
  • zh-cn: 中国語 (簡体字)
  • zh-tw: 中国語 (繁体字)

Allowed values : ja, ko, en, zh-cn, zh-tw 
audioDuration integer 

録音の長さ (単位 : ミリ秒)

 

responseMetaData

PropertyTypeDescription
nextCursor string 
 

Response Example

Example

1{2  "notes": [3    {4      "noteId": "0b7ab87a-134b-482a-83a2-6267131972ean",5      "workspaceId": "SA000000000d000000000",6      "userId": "92d6973e-8960-482b-186d-03206fd78512",7      "createdTime": "2025-03-01T10:00:00+09:00",8      "updatedTime": "2025-03-01T10:00:00+09:00",9      "title": "新しいノート",10      "recognitionLanguage": "ja",11      "audioDuration": 5412012    }13  ],14  "responseMetaData": {15    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="16  }17}