Dokumentacja API

REST API DragApp pozwala programowo pracować z Twoimi tablicami, kolumnami, kartami, etykietami i sekwencjami e-maili. Twórz integracje, automatyzuj przepływy pracy i synchronizuj Drag z narzędziami, których już używasz.

keyPobierz swój klucz APIopen_in_newDokumentacja API w aplikacji

Uwierzytelnianie

API DragApp uwierzytelnia żądania za pomocą kluczy API. Umieść swój klucz API w nagłówku Autoryzacja w nagłówku każdego żądania.

Klucz API znajdziesz w Ustawieniach w Drag. Jeśli nie masz konta, zarejestruj się tutaj.

Przykładowe żądanie
curl --request GET \
  --url https://app.dragapp.com/v2/board \
  --header 'Authorization: YOUR_API_KEY'

Chroń swój klucz API. Nie udostępniaj go publicznie i nie umieszczaj go w systemie kontroli wersji.

Bazowy adres URL

Wszystkie endpointy są względne wobec tego bazowego adresu URL:

https://app.dragapp.com/v2/

Format odpowiedzi

Wszystkie odpowiedzi zwracają JSON o spójnej strukturze. Kody z zakresu 200 oznaczają powodzenie. Kody z zakresu 400 oznaczają błąd w żądaniu.

Sukces
{
  "message": "Success message",
  "error": false,
  "code": 200,
  "data": { ... }
}
Błąd
{
  "message": "Error message",
  "code": 400,
  "error": true
}

Kody statusu HTTP

KodOpis
200OK. Żądanie zakończone powodzeniem.
400Nieprawidłowe żądanie. Błędne parametry.
401Brak autoryzacji. Nieprawidłowy lub brakujący klucz API.
403Brak dostępu. Niewystarczające uprawnienia.
404Nie znaleziono. Zasób nie istnieje.
429Przekroczono limit. Zbyt wiele żądań.
500Błąd serwera. Coś poszło nie tak po naszej stronie.

Tablice

Tablice to kontenery najwyższego poziomu w Drag. Każda tablica odpowiada wspólnej skrzynce odbiorczej lub obszarowi zadań w Gmailu.

GET/v2/board
Wyświetl wszystkie tablice
GET/v2/board/:id
Pobierz jedną tablicę
POST/v2/board
Utwórz tablicę

Utwórz tablicę

Tworzy tablicę w Twoim Gmailu.

Parametry

NazwastringWymagane

Nazwa tablicy

Przykład: "Tablica wsparcia"

UżytkownicylistOpcjonalnie

Lista e-maili użytkowników

Przykład: ["aj@dragapp.com"]

Odpowiedź
{
  "message": "Board created successfully",
  "error": false,
  "code": 200,
  "data": {
    "Id": 404303,
    "BoardName": "Testing V2 Board"
  }
}

Lista tablic

Wyświetla wszystkie typy tablic.

Brak parametrów.

Odpowiedź
{
  "message": "Board list",
  "error": false,
  "code": 200,
  "data": [
    {
      "Id": 162461,
      "Name": "A's Inbox",
      "Owner": "aj@dragapp.com",
      "Users": "akdev013@gmail.com"
    }
  ]
}

Pobierz tablicę

Pobiera szczegóły jednej tablicy.

Brak parametrów w treści żądania. Przekaż ID tablicy w ścieżce URL.

Odpowiedź
{
  "message": "Board details",
  "error": false,
  "code": 200,
  "data": {
    "Id": 162461,
    "Name": "A's Inbox",
    "Owner": "aj@dragapp.com",
    "Users": "akdev013@gmail.com"
  }
}

Kolumny

Kolumny to etapy Twojej tablicy Kanban (np. Do zrobienia, W toku, Gotowe). Każda kolumna należy do tablicy.

GET/v2/board/:boardId/columns
Wyświetl wszystkie kolumny tablicy
GET/v2/board/:boardId/column/:id
Pobierz jedną kolumnę
GET/v2/board/:boardId/column/:columnId/cards
Wyświetl wszystkie karty w kolumnie
POST/v2/board/:boardId/column
Utwórz kolumnę

Utwórz kolumnę

Tworzy kolumnę na tablicy.

Parametry

NazwastringWymagane

Nazwa kolumny

Przykład: "Do zrobienia"

Odpowiedź
{
  "message": "Column created successfully",
  "error": false,
  "code": 200,
  "data": {
    "Success": "Column created successfully."
  }
}

Lista kolumn

Wyświetla wszystkie kolumny tablicy.

Brak parametrów w treści żądania.

Odpowiedź
{
  "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" }
  ]
}

Lista kart w kolumnie

Wyświetla wszystkie karty w kolumnie. Obsługuje paginację.

Parametry

pagenumberWymagane

Numer strony

Przykład: 1

limitstringOpcjonalnie

Liczba kart na stronie

Przykład: "10"

Odpowiedź
{
  "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": "[{}]"
    }
  ]
}

Karty

Karty to pojedyncze zadania lub wątki e-mail na tablicy. Karty mogą mieć notatki, komentarze, podzadania, etykiety i osoby odpowiedzialne.

GET/v2/card/:id
Pobierz szczegóły karty
POST/v2/card
Utwórz kartę
PUT/v2/card/:cardId
Aktualizacja karty
POST/v2/card/move-card
Przenieś kartę do innej kolumny lub na inną tablicę
USUŃ/v2/card/:cardId
Archiwizuj kartę
POST/v2/card/:cardId/note
Dodaj notatkę do karty
POST/v2/card/:cardId/tags
Dodaj tag do karty
POST/v2/card/:cardId/sub-task
Dodaj podzadanie do karty

Utwórz kartę

Tworzy kartę na tablicy.

Parametry

BoardIdnumberWymagane

Tablica, do której chcesz dodać kartę

Przykład: 20841

ColumnIdnumberWymagane

Kolumna tablicy, do której chcesz dodać kartę

Przykład: 1094

CardTitlestringWymagane

Tytuł karty

Przykład: "Zadanie planowania"

NotatkastringOpcjonalnie

Notatka, która zostanie dodana do karty

KomentarzstringOpcjonalnie

Komentarz do dodania na karcie

SubTaskstringOpcjonalnie

Podzadanie do dodania na karcie

Osoba odpowiedzialnalistOpcjonalnie

E-mail osoby odpowiedzialnej lub null, aby cofnąć przypisanie

Przykład: ["aj@dragapp.com"]

ReadStatusnumberOpcjonalnie

Przeczytane = 1, Nieprzeczytane = 0. Domyślnie Przeczytane.

Przykład: 1

Odpowiedź
{
  "Error": false,
  "Success": "Task Added Successfully",
  "taskId": 200433
}

Aktualizuj kartę

Aktualizuje istniejącą kartę.

Parametry

BoardIdnumberWymagane

Tablica, na której znajduje się karta

Przykład: 20841

ColumnIdnumberWymagane

Kolumna tablicy, w której znajduje się karta

Przykład: 1094

CardTitlestringWymagane

Tytuł karty

Przykład: "Zadanie planowania"

NotatkastringOpcjonalnie

Notatka do karty

KomentarzstringOpcjonalnie

Komentarz do karty

SubTaskstringOpcjonalnie

Podzadanie dla karty

Osoba odpowiedzialnalistOpcjonalnie

E-mail osoby odpowiedzialnej lub null, aby cofnąć przypisanie

Przykład: ["aj@dragapp.com"]

Odpowiedź
{
  "message": "Card updated successfully.",
  "error": false,
  "code": 200,
  "data": "2451"
}

Przenieś kartę

Przenieś kartę do innej kolumny lub na inną tablicę.

Parametry

IdstringWymagane

Karta do przeniesienia

Przykład: "18ac0539048b4d0d"

NewBoardIdnumberOpcjonalnie

Tablica, na którą chcesz przenieść kartę

Przykład: 1094

NewColumnIdnumberWymagane

Kolumna tablicy, do której chcesz przenieść kartę

Przykład: 1094

NewPositionnumberWymagane

Pozycja w kolumnie, na którą chcesz przenieść kartę

Przykład: 0

Odpowiedź
{
  "message": "Card moved successfully.",
  "error": false,
  "code": 200,
  "data": "success"
}

Dodaj notatkę

Dodaj notatkę do karty.

Parametry

TreśćstringWymagane

Notatka, która zostanie dodana do karty

Odpowiedź
{
  "message": "Note added to card successfully.",
  "error": false,
  "code": 200,
  "data": { "CardId": "200429" }
}

Dodaj tag do karty

Dodaj tag do karty.

Parametry

TagIdstringWymagane

Etykieta do dodania do karty

Przykład: "77155"

Odpowiedź
{
  "message": "Added tag to card successfully.",
  "error": false,
  "code": 200,
  "data": { "CardId": "200429" }
}

Dodaj podzadanie

Dodaj podzadanie do karty.

Parametry

TreśćstringWymagane

Podzadanie do dodania na karcie

Przykład: "Podzadanie 1"

Odpowiedź
{
  "message": "SubTask added to card successfully.",
  "error": false,
  "code": 200,
  "data": { "CardId": "200429" }
}

Archiwizuj kartę

Archiwizuj (usuń) kartę.

Brak parametrów w treści żądania. Przekaż ID karty w ścieżce URL.

Odpowiedź
{
  "message": "Card archived successfully.",
  "error": false,
  "code": 200,
  "data": { "id": "43813" }
}

Komentarze

Komentarze to wewnętrzne wiadomości zespołu dołączone do kart.

POST/v2/comment
Dodaj komentarz do karty
GET/v2/comment/:commentId
Pobierz komentarz
PUT/v2/comment/:commentId
Aktualizacja komentarza
USUŃ/v2/comment/:commentId
Usuń komentarz

Dodaj komentarz

Parametry

CardIdstringWymagane

Karta, do której chcesz dodać komentarz

Przykład: "77155"

TreśćstringWymagane

Komentarz do dodania na karcie

Odpowiedź
{
  "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"
    }
  }
}

Aktualizuj komentarz

Parametry

TreśćstringWymagane

Komentarz do zaktualizowania

Odpowiedź
{
  "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"
    }
  }
}

Tagi

Etykiety to kolorowe oznaczenia, które można nadawać kartom, aby je kategoryzować i filtrować.

GET/v2/tag
Wyświetl tagi tablicy
POST/v2/tag
Utwórz etykietę
USUŃ/v2/tag
Usuń etykietę

Lista tagów

Wyświetla wszystkie tagi tablicy.

Parametry

BoardIdnumberWymagane

Tablica, z której chcesz pobrać etykiety

Przykład: 20841

Odpowiedź
{
  "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 }
  ]
}

Utwórz etykietę

Parametry

BoardIdnumberWymagane

Tablica, na której chcesz utworzyć etykietę

Przykład: 20841

NazwastringWymagane

Nazwa etykiety

Przykład: "Oczekujące"

KolornumberWymagane

Kolor etykiety

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

Usuń etykietę

Parametry

BoardIdnumberWymagane

Tablica, na której utworzono etykietę

Przykład: 20841

TagIdnumberWymagane

ID etykiety

Przykład: 77162

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

Sekwencje e-mailowe

Sekwencje e-mailowe to zautomatyzowane łańcuchy e-maili uzupełniających, które można planować i śledzić.

GET/v2/email-sequence
Wyświetl wszystkie sekwencje e-maili
GET/v2/email-sequence/:id
Pobierz sekwencję e-maili

Wyświetl wszystko

Brak parametrów.

Odpowiedź
{
  "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"
}

Pobierz sekwencję e-maili

Pobiera jedną sekwencję e-maili ze wszystkimi krokami follow-up.

Brak parametrów w treści żądania. Przekaż ID sekwencji w ścieżce URL.

Odpowiedź
{
  "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
    }
  ]
}

Limity żądań

Limity żądań dotyczą wszystkich endpointów API. Jeśli otrzymasz 429 , zmniejsz częstotliwość żądań i ponów próbę z wykładniczym wycofywaniem (exponential backoff).

SDK i narzędzia

terminal

CLI i oficjalne SDK

Wkrótce

hexagon

MCP (Model Context Protocol)Na żywo

47 narzędzi dla Claude, ChatGPT, Gemini, Copilot, Cursor i innych

Potrzebujesz pomocy?

Centrum pomocy: przewodniki, samouczki i FAQ

Dokumentacja API w aplikacji: interaktywna dokumentacja API na Twoim koncie DragApp

support@dragapp.com: skontaktuj się bezpośrednio z zespołem