APIドキュメント
DragAppのREST APIを使うと、ボード、カラム、カード、タグ、メールシーケンスをプログラムから操作できます。連携を構築し、ワークフローを自動化し、Dragをお使いのツールと同期しましょう。
認証
DragAppのAPIは、APIキーを使ってリクエストを認証します。APIキーは認可 ヘッダーに含めて、すべてのリクエストで送信してください。
APIキーは、次のアプリ内の設定から取得できます: Drag。アカウントをお持ちでない場合は、 こちらから登録.
curl --request GET \
--url https://app.dragapp.com/v2/board \
--header 'Authorization: YOUR_API_KEY'APIキーは安全に保管してください。公開したり、バージョン管理システムにコミットしたりしないでください。
ベースURL
すべてのエンドポイントは、このベースURLからの相対パスです:
https://app.dragapp.com/v2/応答形式
すべてのレスポンスは、一貫した構造のJSONで返されます。200番台のコードは成功を、400番台のコードはリクエストのエラーを示します。
{
"message": "Success message",
"error": false,
"code": 200,
"data": { ... }
}{
"message": "Error message",
"code": 400,
"error": true
}HTTPステータスコード
| コード | 説明 |
|---|---|
| 200 | OK。リクエストは成功しました。 |
| 400 | Bad Request。パラメータが無効です。 |
| 401 | 認証されていません。APIキーが無効か、指定されていません。 |
| 403 | アクセスが拒否されました。権限が不足しています。 |
| 404 | Not Found。リソースが存在しません。 |
| 429 | Rate Limited。リクエストが多すぎます。 |
| 500 | サーバーエラーです。こちら側で問題が発生しました。 |
ボード
ボードはDragの最上位のコンテナです。各ボードは、Gmailの共有受信トレイまたはタスク用ワークスペースに対応しています。
/v2/board/v2/board/:id/v2/boardボードを作成
Gmailでボードを作成します。
パラメーター
名前string必須ボードの名前
例:「サポートボード」
ユーザーlist任意ユーザーのメールアドレスの一覧
例:["aj@dragapp.com"]
{
"message": "Board created successfully",
"error": false,
"code": 200,
"data": {
"Id": 404303,
"BoardName": "Testing V2 Board"
}
}ボードを一覧表示
すべての種類のボードを一覧表示します。
パラメーターはありません。
{
"message": "Board list",
"error": false,
"code": 200,
"data": [
{
"Id": 162461,
"Name": "A's Inbox",
"Owner": "aj@dragapp.com",
"Users": "akdev013@gmail.com"
}
]
}ボードを取得
単一のボードの詳細を取得します。
ボディパラメーターはありません。ボードIDはURLパスで渡します。
{
"message": "Board details",
"error": false,
"code": 200,
"data": {
"Id": 162461,
"Name": "A's Inbox",
"Owner": "aj@dragapp.com",
"Users": "akdev013@gmail.com"
}
}列
列は、カンバンボードの段階(例:To Do、Doing、Done)を表します。各列は1つのボードに属します。
/v2/board/:boardId/columns/v2/board/:boardId/column/:id/v2/board/:boardId/column/:columnId/cards/v2/board/:boardId/columnカラムを作成
ボードにカラムを作成します。
パラメーター
名前string必須列の名前
例:「未対応」
{
"message": "Column created successfully",
"error": false,
"code": 200,
"data": {
"Success": "Column created successfully."
}
}列を一覧表示
ボードのすべての列を一覧表示します。
ボディパラメーターはありません。
{
"message": "Columns list",
"error": false,
"code": 200,
"data": [
{ "Id": 158415, "ColumnId": "Label_1", "Name": "To Do" },
{ "Id": 158416, "ColumnId": "Label_2", "Name": "Doing" },
{ "Id": 158417, "ColumnId": "Label_3", "Name": "Done" }
]
}列のカードを一覧表示
列内のすべてのカードを一覧表示します。ページネーションに対応しています。
パラメーター
pagenumber必須ページ番号
例:1
limitstring任意1ページあたりのカード数
例:"10"
{
"message": "Column cards",
"error": false,
"code": 200,
"data": [
{
"DragTaskId": 200442,
"TaskName": "Task",
"ReadUnreadStatus": 1,
"ColumnId": "Label_1",
"BoardId": 404302,
"DueDate": null,
"Assignees": null,
"ThreadOwnerEmail": "aj@dragapp.com",
"CreatedAt": "2023-10-31T04:38:31.000Z",
"Status": "1",
"CustomFields": "[{}]"
}
]
}カード
カードは、ボード上の個々のタスクやメールスレッドを表します。カードにはメモ、コメント、サブタスク、タグ、担当者を設定できます。
/v2/card/:id/v2/card/v2/card/:cardId/v2/card/move-card/v2/card/:cardId/v2/card/:cardId/note/v2/card/:cardId/tags/v2/card/:cardId/sub-taskカードを作成
ボードにカードを作成します。
パラメーター
BoardIdnumber必須カードを追加するボード
例:20841
ColumnIdnumber必須カードを追加するボードの列
例:1094
CardTitlestring必須カードのタイトル
例:「計画タスク」
メモstring任意カードに追加するメモ
コメントstring任意カードに追加するコメント
SubTaskstring任意カードに追加するサブタスク
担当者list任意担当者のメールアドレス。割り当てを解除する場合はnull
例:["aj@dragapp.com"]
ReadStatusnumber任意既読 = 1、未読 = 0。デフォルトは既読です。
例:1
{
"Error": false,
"Success": "Task Added Successfully",
"taskId": 200433
}カードを更新
既存のカードを更新します。
パラメーター
BoardIdnumber必須カードがあるボード
例:20841
ColumnIdnumber必須カードがあるボードの列
例:1094
CardTitlestring必須カードのタイトル
例:「計画タスク」
メモstring任意カードのメモ
コメントstring任意カードへのコメント
SubTaskstring任意カードのサブタスク
担当者list任意担当者のメールアドレス。割り当てを解除する場合はnull
例:["aj@dragapp.com"]
{
"message": "Card updated successfully.",
"error": false,
"code": 200,
"data": "2451"
}カードを移動
カードを別の列や別のボードに移動します。
パラメーター
Idstring必須移動するカード
例:"18ac0539048b4d0d"
NewBoardIdnumber任意カードの移動先となるボード
例:1094
NewColumnIdnumber必須カードの移動先となるボードの列
例:1094
NewPositionnumber必須カードの移動先となる列内の位置
例:0
{
"message": "Card moved successfully.",
"error": false,
"code": 200,
"data": "success"
}メモを追加
カードにメモを追加します。
パラメーター
本文string必須カードに追加するメモ
{
"message": "Note added to card successfully.",
"error": false,
"code": 200,
"data": { "CardId": "200429" }
}カードにタグを追加
カードにタグを追加します。
パラメーター
TagIdstring必須カードに追加するタグ
例:"77155"
{
"message": "Added tag to card successfully.",
"error": false,
"code": 200,
"data": { "CardId": "200429" }
}サブタスクを追加
カードにサブタスクを追加します。
パラメーター
本文string必須カードに追加するサブタスク
例:「サブタスク1」
{
"message": "SubTask added to card successfully.",
"error": false,
"code": 200,
"data": { "CardId": "200429" }
}カードをアーカイブ
カードをアーカイブ(削除)します。
ボディパラメーターはありません。カードIDはURLパスで渡します。
{
"message": "Card archived successfully.",
"error": false,
"code": 200,
"data": { "id": "43813" }
}メールシーケンス
メールシーケンスは、スケジュール設定と追跡ができる自動フォローアップメールの連なりです。
/v2/email-sequence/v2/email-sequence/:idすべて一覧表示
パラメーターはありません。
{
"EmailTemplateId": 153783,
"UserId": 1000075,
"Name": "Welcome Email Sequence",
"CreatedAt": "2023-11-02T15:59:00.000Z",
"Content": "<p>Hello {{firstName}}, ...</p>",
"Subject": "Welcome Email",
"EmailFollowupId": 8393,
"TotalViewCount": 0,
"LastSent": null,
"OwnerName": "A J",
"OwnerEmail": "aj@dragapp.com"
}メールシーケンスを取得
すべてのフォローアップステップを含む、単一のメールシーケンスを取得します。
ボディパラメーターはありません。シーケンスIDはURLパスで渡します。
{
"Id": "153783",
"Name": "Welcome Email Sequence",
"CreatedAt": "2023-11-02T15:59:00.000Z",
"EmailFollowups": [
{
"EmailFollowupId": 8393,
"Subject": "Welcome Email",
"Content": "<p>Hello {{firstName}}, ...</p>",
"Days": 1,
"Duration": "days",
"Hours": 3,
"Minutes": 30,
"Sequence": 1
},
{
"EmailFollowupId": 8394,
"Subject": "Re: Welcome Email",
"Days": 1,
"Duration": "days",
"Sequence": 2
}
]
}レート制限
レート制限はすべてのAPIエンドポイントに適用されます。もし 429 ステータスコードを受け取った場合は、リクエストの頻度を下げ、エクスポネンシャルバックオフで再試行してください。
SDKとツール
お困りですか?
ヘルプセンター:ガイド、チュートリアル、よくある質問
アプリ内のAPIドキュメント:DragAppアカウント内のインタラクティブなAPIリファレンス
support@dragapp.com:チームに直接問い合わせる

コメント
コメントは、カードに付けられるチーム内のメッセージです。
/v2/comment/v2/comment/:commentId/v2/comment/:commentId/v2/comment/:commentIdコメントを追加
パラメーター
CardIdstring必須コメントを追加するカード
例:"77155"
本文string必須カードに追加するコメント
コメントを更新
パラメーター
本文string必須更新するコメント