Garoon API ドキュメント

ToDo を取得する

目次

ToDo を取得する

ToDo の ID を指定することで、API を実行したユーザー個人の ToDo リストの ToDo を取得します。

URL

https://sample.cybozu.com/g/api/v1/todo/todos/ToDo ID

パスパラメーター
パラメーター名 説明
ToDo ID 取得する ToDo の ToDo ID

HTTP メソッド

GET

利用できるバージョン

  • クラウド版 Garoon

必要なアクセス権

なし

リクエスト

パラメーター

なし

リクエストの例
URL

https://sample.cybozu.com/g/api/v1/todo/todos/3

ヘッダー
1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

リクエストヘッダーの詳細は Garoon REST API の共通仕様 を参照してください。

レスポンス

プロパティ
プロパティ名 型 説明
id 数値 ToDo の ID
status 文字列 ToDo のステータス
次のいずれかの値が返ります。
  • Completed：完了
  • Uncompleted：未処理
category 数値 ToDo のカテゴリー ID
ToDo が「すべて」のカテゴリーにある場合は、0が返されます。
subject 文字列 ToDo 名
hasDueDate 真偽値 締切日があるかどうか
  • true：ToDo の締切日が設定されている
  • false：ToDo の締切日が設定されていない
dueDate 文字列 ToDo の締切日
形式は ISO8601 の UTC タイムゾーンです。
hasDueDate の値が false の場合、このプロパティはオブジェクトに含まれません。
priority 数値 ToDo の重要度
次のいずれかの値が返ります。数が大きいほど重要度は高くなります。
  • 1
  • 2
  • 3
notes 文字列 メモ
改行文字は「\n」です。
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "id": 1,
  "status": "Completed",
  "category": 123,
  "subject": "Implement Unit test",
  "hasDueDate": true,
  "dueDate": "2023-01-14T00:00:00+09:00",
  "priority": 2,
  "notes": "This is todo note. You can write multiple lines."
}

サンプルコード

curl を使ったリクエスト
1
2

curl -X GET 'https://sample.cybozu.com/g/api/v1/todo/todos/3' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='
Garoon REST API リクエストを送信する API を使ったリクエスト
1

await garoon.api('/api/v1/todo/todos/3', 'GET', {});

注意事項

  • スペースの共有 ToDo は操作できません。