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ステータスコード

コード説明
200OK。リクエストは成功しました。
400Bad Request。パラメータが無効です。
401認証されていません。APIキーが無効か、指定されていません。
403アクセスが拒否されました。権限が不足しています。
404Not Found。リソースが存在しません。
429Rate Limited。リクエストが多すぎます。
500サーバーエラーです。こちら側で問題が発生しました。

ボード

ボードはDragの最上位のコンテナです。各ボードは、Gmailの共有受信トレイまたはタスク用ワークスペースに対応しています。

GET/v2/board
すべてのボードを一覧表示します
GET/v2/board/:id
単一のボードを取得
POST/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つのボードに属します。

GET/v2/board/:boardId/columns
ボードのすべての列を一覧表示します
GET/v2/board/:boardId/column/:id
単一の列を取得
GET/v2/board/:boardId/column/:columnId/cards
列内のすべてのカードを一覧表示します
POST/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": "[{}]"
    }
  ]
}

カード

カードは、ボード上の個々のタスクやメールスレッドを表します。カードにはメモ、コメント、サブタスク、タグ、担当者を設定できます。

GET/v2/card/:id
カードの詳細を取得
POST/v2/card
カードを作成
PUT/v2/card/:cardId
カードを更新する
POST/v2/card/move-card
カードを別の列またはボードに移動
DELETE/v2/card/:cardId
カードをアーカイブする
POST/v2/card/:cardId/note
カードにメモを追加
POST/v2/card/:cardId/tags
カードにタグを追加
POST/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" }
}

コメント

コメントは、カードに付けられるチーム内のメッセージです。

POST/v2/comment
カードにコメントを追加
GET/v2/comment/:commentId
コメントを取得
PUT/v2/comment/:commentId
コメントを更新する
DELETE/v2/comment/:commentId
コメントを削除

コメントを追加

パラメーター

CardIdstring必須

コメントを追加するカード

例:"77155"

本文string必須

カードに追加するコメント

応答
{
  "message": "Comment created successfully.",
  "error": false,
  "code": 200,
  "data": {
    "Error": false,
    "Success": "Comment added successfully",
    "CommentDetails": {
      "CommentId": 549007,
      "UserId": 1000075,
      "Comment": "Hello comment added",
      "EntityId": "200428",
      "CreatedAt": "2023-10-29T11:29:35.000Z"
    }
  }
}

コメントを更新

パラメーター

本文string必須

更新するコメント

応答
{
  "message": "Comment updated successfully.",
  "error": false,
  "code": 200,
  "data": {
    "Error": false,
    "Success": "Comment updated successfully",
    "CommentDetails": {
      "CommentId": 549002,
      "Comment": "updating 1 existing comment",
      "EntityId": "200428",
      "CreatedAt": "2023-10-08T12:32:26.000Z"
    }
  }
}

タグ

タグは、分類や絞り込みのためにカードに付けられる色付きのラベルです。

GET/v2/tag
ボードのタグを一覧表示
POST/v2/tag
タグを作成
DELETE/v2/tag
タグを削除

タグを一覧表示

ボードのすべてのタグを一覧表示します。

パラメーター

BoardIdnumber必須

タグを取得するボード

例:20841

応答
{
  "message": "Tag list fetched successfully.",
  "error": false,
  "code": 200,
  "data": [
    { "Id": 77163, "Name": "Tag 1", "Color": "8", "BoardId": 20841 },
    { "Id": 77164, "Name": "Tag 2", "Color": "1", "BoardId": 20841 }
  ]
}

タグを作成

パラメーター

BoardIdnumber必須

タグを作成するボード

例:20841

名前string必須

タグの名前

例:「保留中」

カラーnumber必須

タグの色

応答
{
  "message": "Tag crated successfully.",
  "error": false,
  "code": 200,
  "data": {
    "Id": 77162,
    "Name": "Tag 3 API 2",
    "Color": "11",
    "Description": null,
    "BoardId": 3007,
    "UserId": 1000075
  }
}

タグを削除

パラメーター

BoardIdnumber必須

タグが作成されたボード

例:20841

TagIdnumber必須

タグID

例:77162

応答
{
  "message": "Tag deleted successfully.",
  "error": false,
  "code": 200,
  "data": { "Id": 77162 }
}

メールシーケンス

メールシーケンスは、スケジュール設定と追跡ができる自動フォローアップメールの連なりです。

GET/v2/email-sequence
すべてのメールシーケンスを一覧表示します
GET/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:チームに直接問い合わせる