GET/users/{userId}/ainote/notes

내 노트 목록을 조회한다. startTime ~ endTime 시간은 최대 1년이다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증을 참고한다.

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 

목록 커서값

 
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)

  • 「+」는 「%2B」로 인코딩해야 한다.
  • 기본값은 endTime으로부터 1년 전이다.

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

조회 종료 일시(형식: YYYY-MM-DDThh:mm:ssTZD)

  • 「+」는 「%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

 
workspcaeId string 

워크스페이스 ID

 
userId string 

노트를 생성한 사용자 ID

 
createdTime string 

노트 생성 시각(YYYY-MM-DDThh:mm:ssTZD)

 
updatedTime string 

노트 업데이트 시각(YYYY-MM-DDThh:mm:ssTZD)

 
title string 

노트 제목

 
recognitionLanguage string 

인식 언어

  • ko: 한국어
  • en: 영어
  • ja: 일본어
  • zh-cn: 중국어(간체)
  • zh-tw: 중국어(번체)
  • enko: 한국어+영어
  • jako: 한국어+일본어

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

오디오 길이(단위: millisecond)

 

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": "ko",11      "audioDuration": 5412012    }13  ],14  "responseMetaData": {15    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="16  }17}