Dokumentacja dla programistów

Dokumenty

Dokumentacja API (rdzeń)Dokumentacja API

Aktualizacja 2026-10-18

Workdocs to centralne miejsce, w którym zespoły wspólnie planują i realizują pracę. Przypominają wirtualne tablice, na których można zapisywać notatki, tworzyć wykresy i dodawać elementy do tablicy na podstawie wpisanego tekstu.

Dokumenty umożliwiają zespołom współpracę w czasie rzeczywistym bez nadpisywania swojej pracy. Użytkownicy mogą też korzystać z wbudowanych funkcji, takich jak widżety, szablony i aplikacje, aby rozszerzać możliwości dokumentów.

Zapytania

Pobieranie dokumentów

Wymagany zakres:docs:read
Zwraca tablicę zawierającą metadane kolekcji dokumentów
Zapytanie można wykonać bezpośrednio tylko na poziomie głównym; nie można umieścić go wewnątrz innego zapytania

query {
  docs(
    object_ids: [123456789]
    limit: 1
  ) {
    id
    object_id
    settings
    created_by {
      id
      name
    }
  }
}

Argumenty

Argument	Typ	Opis	Wartości wyliczeniowe
ids	`[ID!]`	Unikalny wewnętrzny identyfikator dokumentu. W interfejsie jest to identyfikator widoczny w lewym górnym rogu dokumentu po włączeniu trybu deweloperskiego. Jest to również wartość zwracana przez zapytanie `docs`.
limit	`Int`	Liczba dokumentów do pobrania. Wartość domyślna to 25.
object_ids	`[ID!]`	Unikalny identyfikator lub identyfikatory dokumentów. W interfejsie jest to identyfikator widoczny w adresie URL i wartościach kolumny dokumentu.
order_by	`DocsOrderBy`	Kolejność pobierania tablic. Domyślnie dokumenty są sortowane według created_at, od najnowszych. Ten argument nie jest stosowany, jeśli dokumenty są pobierane za pomocą konkretnych wartości `ids`.	`created_at` `used_at`
page	`Int`	Numer zwracanej strony. Numeracja zaczyna się od 1.
workspace_ids	`[ID]`	Unikalne identyfikatory obszarów roboczych, które mają zostać zwrócone.

Pola

Pole	Typ	Opis	Wartości wyliczeniowe
blocks	`[DocumentBlock]`	Bloki zawierające treść dokumentu.
created_at	`Date`	Data utworzenia dokumentu.
created_by	`User`	Osoba, która utworzyła dokument.
doc_folder_id	`ID`	Unikalny identyfikator folderu zawierającego dokument. Zwraca `null` dla pierwszego poziomu.
doc_kind	`BoardKind!`	Typ dokumentu.	`private` `public` `share`
id	`ID!`	Unikalny identyfikator dokumentu. W interfejsie jest widoczny w lewym górnym rogu dokumentu po włączeniu trybu deweloperskiego. Można go przekazać w argumencie `ids`.
name	`String!`	Nazwa dokumentu.
object_id	`ID!`	Unikalny identyfikator powiązanej tablicy lub obiektu. W interfejsie jest to identyfikator widoczny w adresie URL i wartościach kolumny dokumentu.
relative_url	`String`	Względny adres URL dokumentu.
updated_at	`Date`	Data ostatniej aktualizacji dokumentu.
url	`String`	Bezpośredni adres URL dokumentu.
workspace	`Workspace`	Obszar roboczy zawierający ten dokument. Zwraca `null` dla obszaru roboczego Main.
workspace_id	`ID`	Unikalny identyfikator obszaru roboczego zawierającego dokument. Zwraca `null` dla obszaru roboczego Main.
settings	`JSON`	Ustawienia dokumentu.

Pole settings

Pole settings zwraca ustawienia dokumentu. Poniżej znajduje się przykładowy obiekt. Pamiętaj jednak, że API zwraca dane w nieco innym formacie, używając znaków ucieczki w JSON-ie.

{
  "fontSize": "small", // "small", "normal", or "large"
  "hasTitle": true, // true or false
  "coverPhoto": {
    "isEnabled": true, // true or false
    "imageUrl": "", 
    "fromTop": 0
     },
  "fontFamily": "Serif", // "Serif", "Mono", or "Default"
  "isPageLayout": true, // true or false
  "backgroundColor": "var(--color-sofia_pink-selected)", 
  "isFullWidthMode": false, // true or false
  "backgroundPattern": null, // "sticky-note", "notepad", or "cubes-notepad"
  "showTableOfContent": true // true or false
}

Mutacje

Wymagany zakres:docs:write

Tworzenie dokumentu

Tworzy nowy dokument w kolumnie dokumentu lub obszarze roboczym. Zwraca obiekt Document.

mutation {
  create_doc(
    location: {
      workspace: {
        workspace_id: 12345678
        name: "New doc"
        kind: private
      }
    }
  ) {
    id
  }
}

Argumenty

Argument	Typ	Opis
location	`CreateDocInput!`	Miejsce, w którym powstanie dokument.

Dodawanie treści do dokumentu z Markdowna

Dodaje treść w formacie Markdown do istniejącego dokumentu monday. Markdown zostanie przetworzony i zamieniony na odpowiadające mu typy bloków. Zwraca DocBlocksFromMarkdownResult.

mutation {
  add_content_to_doc_from_markdown(
    docId: 123456, 
    markdown: "# Markdown Example\n\n**Bold text**, *italic text*, and `inline code`.\n\n- Item one\n- Item two\n\n> A simple blockquote."
  ) {
    success
    block_ids
    error
  }
}

{
  "data": {
    "add_content_to_doc_from_markdown": {
      "success": true,
      "block_ids": [
                "7fa2d9c4-1b3e-4c67-9f5a-2d9d84e3a912",
                "c4b6e2f1-59a7-4c12-b3de-8a1d4e0f42ac",
                "2d3f6b19-83e2-45cd-b9a1-7fe6493b0f56",
                "9b4d1f22-6c3a-4879-a82d-1e2c3f8d9a77",
                "e5c8f320-7a14-4d9c-b25e-9f1a2c4d8b33"
      ],
      "error": null
    }
  },
  "extensions": {
    "request_id": "YOUR_REQUEST_ID"
  }
}

Argumenty

Argument	Typ	Opis
afterBlockId	`String`	Unikalny identyfikator bloku, po którym należy wstawić treść Markdown.
docId	`ID!`	Unikalny identyfikator dokumentu, do którego ma zostać dodana treść.
markdown	`String!`	Treść w formacie Markdown do dodania i przekonwertowania.

Importowanie dokumentu z HTML-a

Importuje treść HTML do nowego dokumentu monday. Kod HTML zostanie przetworzony i zamieniony na odpowiadające mu typy bloków. Obecnie obsługiwane są następujące typy bloków: tekst ze stylami lub formatowaniem, emoji, cytat, tabela, lista, kod, separator oraz tytuł lub nagłówek. Zwraca ImportDocFromHtmlResult.

mutation {
  import_doc_from_html(
    html: """
<!DOCTYPE html>
<html>
  <head>
    <title>Test Doc</title>
  </head>
  <body>
    <h1>Hello World</h1>
    <p>This is a <strong>fake HTML</strong> doc for testing.</p>
    <ul>
      <li>One</li>
      <li>Two</li>
      <li>Three</li>
    </ul>
  </body>
</html>
    """,
    workspaceId: 1234567890,
    title: "New Doc from HTML",
    folderId: 9876543210
  ) {
    error
    success
    doc_id
  }
}

{
  "data": {
    "import_doc_from_html": {
      "error": null,
      "success": true,
      "doc_id": "12345"
    }
  },
  "extensions": {
    "request_id": "YOUR_REQUEST_ID"
  }
}

Argumenty

Argument	Typ	Opis	Wartości wyliczeniowe
folderId	`ID`	Unikalny identyfikator folderu, w którym ma zostać utworzony dokument. Jeśli nie podasz tej wartości, dokument zostanie utworzony na głównym poziomie obszaru roboczego.
html	`String!`	Treść HTML do przekonwertowania na nowy dokument.
kind	`DocKind`	Poziom dostępu do dokumentu.	`private` `public` `share`
title	`String`	Tytuł nowego dokumentu. Jeśli go nie podasz, zostanie określony na podstawie przekazanej treści HTML.
workspaceId	`ID!`	Unikalny identyfikator obszaru roboczego, w którym ma zostać utworzony dokument.

Zmiana nazwy dokumentu

Zmienia nazwę lub tytuł istniejącego dokumentu. Zwraca obiekt JSON zawierający zaktualizowaną nazwę.

mutation {
  update_doc_name(
    docId: 12345, 
    name: "The new document name."
    )
}

Argumenty

Argument	Typ	Opis
docId	`Int!`	Unikalny identyfikator dokumentu.
name	`String!`	Nowa nazwa dokumentu.

Duplikowanie dokumentu

Tworzy dokładną kopię istniejącego dokumentu monday.com, wraz z całą jego treścią i strukturą. Zwraca obiekt JSON zawierający identyfikator nowego dokumentu.

mutation {
  duplicate_doc(
    docId: 12345, 
    duplicateType: duplicate_doc_with_content_and_updates
    )
}

Argumenty

Argument	Typ	Opis	Wartości wyliczeniowe
docId	`Int!`	Unikalny identyfikator dokumentu.
duplicateType	`DuplicateType`	Typ duplikowania dokumentu.	`duplicate_doc_with_content` (tylko treść dokumentu) `duplicate_doc_with_content_and_updates` (treść oraz powiązane aktualizacje)

Usuwanie dokumentu

Usuwa istniejący dokument. Zwraca obiekt JSON z informacją, czy usunięcie się powiodło, oraz identyfikatorem usuniętego dokumentu.

mutation {
  delete_doc (
    docId: 12345
    )
}

Argumenty

Argument	Typ	Opis
docId	`ID!`	Unikalny identyfikator dokumentu.

Historia wersji

Dostępne tylko w wersji API 2026-04 i nowszych

Pobieranie historii wersji dokumentu

Zwraca listę punktów przywracania (zrzutów stanu) dokumentu, pogrupowanych w 5-minutowych przedziałach. Każdy punkt przywracania zawiera znacznik czasu oraz identyfikatory użytkowników, którzy wprowadzili zmiany.

Wymagany zakres: docs:read

query {
  doc_version_history(
    doc_id: "1234567890"
    since: "2025-01-01T00:00:00Z"
  ) {
    doc_id
    restoring_points {
      date
      user_ids
      type
    }
  }
}

Argumenty

Argument	Typ	Opis
doc_id	`ID!`	Unikalny identyfikator dokumentu (identyfikator obiektu z adresu URL).
since	`String`	Opcjonalna dolna granica w formacie ISO 8601 do filtrowania punktów przywracania.
until	`String`	Opcjonalna górna granica w formacie ISO 8601 do filtrowania punktów przywracania.

Pola (`DocVersionHistory`)

Pole	Typ	Opis
doc_id	`ID`	Unikalny identyfikator dokumentu.
restoring_points	`[DocRestoringPoint]`	Lista zrzutów wersji dokumentu.

Pola (`DocRestoringPoint`)

Pole	Typ	Opis
date	`String`	Znacznik czasu punktu przywracania w formacie ISO 8601.
user_ids	`[String]`	Unikalne identyfikatory użytkowników, którzy wprowadzili zmiany w tym przedziale.
type	`String`	Typ punktu przywracania. Zwraca `"publish"` dla zdarzeń publikacji, a w pozostałych przypadkach `null`.

Pobieranie różnic między wersjami dokumentu

Zwraca bloki dodane, usunięte lub zmienione między dwoma punktami przywracania. Uwzględnia tylko bloki, w których zaszły zmiany.

Wymagany zakres: docs:read

query {
  doc_version_diff(
    doc_id: "1234567890"
    date: "2026-01-08T10:24:02.469Z"
    prev_date: "2025-01-01T00:00:00Z"
  ) {
    doc_id
    date
    prev_date
    blocks {
      id
      type
      content
      summary
      parent_block_id
      changes {
        added
        deleted
        changed
      }
    }
  }
}

Argumenty

Argument	Typ	Opis
doc_id	`ID!`	Unikalny identyfikator dokumentu.
date	`String!`	Znacznik czasu nowszego punktu przywracania (ISO 8601).
prev_date	`String!`	Znacznik czasu starszego punktu przywracania (ISO 8601).

Pola (`DocVersionDiff`)

Pole	Typ	Opis
doc_id	`ID`	Unikalny identyfikator dokumentu.
date	`String`	Znacznik czasu nowszego punktu przywracania.
prev_date	`String`	Znacznik czasu starszego punktu przywracania.
blocks	`[DiffBlock]`	Bloki, które zmieniły się między dwiema wersjami.

Pola (`DiffBlock`)

Pole	Typ	Opis
id	`String`	Unikalny identyfikator bloku.
type	`String`	Identyfikator typu bloku.
content	`String`	Treść bloku (może zawierać dane zakodowane w formacie base64).
summary	`String`	Podsumowanie zmiany w czytelnej dla człowieka formie.
parent_block_id	`String`	Unikalny identyfikator bloku nadrzędnego, jeśli blok jest zagnieżdżony.
changes	`BlockChanges`	Obiekt opisujący zmiany w bloku.

Pola (`BlockChanges`)

Pole	Typ	Opis
added	`Boolean`	Informuje, czy blok został dodany.
deleted	`Boolean`	Informuje, czy blok został usunięty.
changed	`Boolean`	Informuje, czy treść bloku została zmieniona.

Mam problem z tym tematem Źródło: developer.monday.com

Dokumenty

Zapytania

Pobieranie dokumentów

Argumenty

Pola

Pole settings

Mutacje

Tworzenie dokumentu

Argumenty

Dodawanie treści do dokumentu z Markdowna

Argumenty

Importowanie dokumentu z HTML-a

Argumenty

Zmiana nazwy dokumentu

Argumenty

Duplikowanie dokumentu

Argumenty

Usuwanie dokumentu

Argumenty

Historia wersji

Pobieranie historii wersji dokumentu

Argumenty

Pola (DocVersionHistory)

Pola (DocRestoringPoint)

Pobieranie różnic między wersjami dokumentu

Argumenty

Pola (DocVersionDiff)

Pola (DiffBlock)

Pola (BlockChanges)

Pola (`DocVersionHistory`)

Pola (`DocRestoringPoint`)

Pola (`DocVersionDiff`)

Pola (`DiffBlock`)

Pola (`BlockChanges`)