Zaloguj się
Nowe zgłoszenie
Dokumentacja dla programistów›Budowa aplikacji›monday.get
Dokumentacja dla programistów

monday.get

Budowa aplikacjiAplikacje monday.com
Aktualizacja 2025-12-02

Za pomocą monday.get możesz pobierać dane z nadrzędnej aplikacji monday.com, w której działa Twoja aplikacja. Tego obiektu można używać tylko w aplikacjach po stronie klienta.

Parametry

Parametr Opis Dostępne typy
type Typ żądanych informacji
  • `'context'`: Informacje o tym, gdzie aplikacja jest obecnie wyświetlana, zależnie od typu funkcji
  • `'settings'`: Ustawienia aplikacji skonfigurowane przez użytkownika, który ją zainstalował
  • `'itemIds'`: Lista identyfikatorów elementów widocznych na bieżącej tablicy (lub wszystkich elementów, jeśli nie zastosowano filtrów)
  • `'sessionToken'`: Token JWT dekodowany przy użyciu sekretu klienta. Można go używać jako tokenu sesji między frontendem a backendem aplikacji
  • `'filter'`: Stan filtra wyszukiwania
  • `'location'`: Adres URL w aplikacji
params Zarezerwowane do przyszłego użycia

Zwracana wartość

Obiekt Promise, który zostanie rozwiązany żądanymi danymi.

Przykłady

Pobieranie tokenu sesji

Za każdym razem, gdy aplikacja się uruchamia, generujemy token sesji podpisany sekretem klienta aplikacji. Użyj typu sessionToken, aby pobrać token. Frontend powinien używać go jako głównego sposobu dostępu do bieżącej subskrypcji.

monday.get('sessionToken')
.then((token) => { 
  // send token to backend
  // On backend, call jwt.verify(token.data, 'MY_CLIENT_SECRET') 
}

Struktura tokenu

{
  "exp": "2023-12-01T00:00:00Z",
  "dat": {
    "account_id": 1234567890,
    "user_id": 9876543210
  }
}

Pobieranie danych kontekstu i ustawień

monday.get("settings").then(res => ...);
monday.get("context").then(res => ...);

Przykładowe obiekty kontekstu dla poszczególnych typów funkcji

AI assistant - Main menu header
{
  "themeConfig": { // may be "undefined" if the default theme is used, defines the color scheme and styling configuration for the app
    "name": "crm-product-theme", 
    "colors": {
      "light": {
        "primary-color": "#007f9b",
        "primary-hover-color": "#006278",
        "primary-selected-color": "#bee3e8",
        "primary-selected-hover-color": "#d4ebef",
        "brand-colors": {
          "brand-color": "#007f9b",
          "brand-hover-color": "#006278",
          "text-color-on-brand": "#ffffff"
        }
      },
      "dark": {
        "primary-color": "#007f9b",
        "primary-hover-color": "#006278",
        "primary-selected-color": "#004858",
        "primary-selected-hover-color": "#003844",
        "brand-colors": {
          "brand-color": "#007f9b",
          "brand-hover-color": "#006278",
          "text-color-on-brand": "#ffffff"
        }
      },
      "black": {
        "primary-color": "#007f9b",
        "primary-hover-color": "#006278",
        "primary-selected-color": "#004858",
        "primary-selected-hover-color": "#003844",
        "brand-colors": {
          "brand-color": "#007f9b",
          "brand-hover-color": "#006278",
          "text-color-on-brand": "#ffffff"
        }
      }
    }
  },
  "location": "boardMainMenuHeader",
  "locationContext": { "boardId": 4213911112, "workspaceId": 2581779 },
  "appFeatureId": 10330064,
  "withExternalWidth": false,
  "withHeaderPadding": true,
  "boardId": 4213911112,
  "workspaceId": 2581779,
  "theme": "light", // or "dark" or "black"
  "subscription": { // app subscription object for marketplace app
    "plan_id": "5",
    "renewal_date": "2023-07-10T00:00:00+00:00",
    "is_trial": false,
    "billing_period": "monthly",
    "days_left": 14,
    "pricing_version": 5,
    "max_units": 100 // maximum number of seats allowed for seat-based plans, null for feature-based plans
  },
  "account": { "id": "1233" },
  "user": {
    "id": "28659824",
    "isAdmin": false,
    "isGuest": false,
    "isViewOnly": false,
    "countryCode": "IL",
    "currentLanguage": "en",
    "timeFormat": "12H",
    "timeZoneOffset": 2
  },
  "region": "use1",
  "app": { "id": 10089476, "clientId": "78643ruyagduyg743tyr812uygd74" },
  "appVersion": {
    "id": 10124592,
    "name": "context printer",
    "status": "draft",
    "type": "major",
    "versionData": { "major": 1, "minor": 0, "patch": 0, "type": "major" },
    "mondayCodeHostingUrl": "https://b325b-service-25854030-b5796b91.us.monday.app" // used only for monday code apps; specifies the region-based hosting URL for server-side code
    }, 
  "appFeature": {
    "type": "AppFeatureAiBoardMainMenuHeader",
    "name": "context printer - v1.0.0"
  }
}
Board menu feature - Board item menu
{
  "themeConfig": { // may be "undefined" if the default theme is used, defines the color scheme and styling configuration for the app
    "name": "crm-product-theme", 
    "colors": {
      "light": {
        "primary-color": "#007f9b",
        "primary-hover-color": "#006278",
        "primary-selected-color": "#bee3e8",
        "primary-selected-hover-color": "#d4ebef",
        "brand-colors": {
          "brand-color": "#007f9b",
          "brand-hover-color": "#006278",
          "text-color-on-brand": "#ffffff"
        }
      },
      "dark": {
        "primary-color": "#007f9b",
        "primary-hover-color": "#006278",
        "primary-selected-color": "#004858",
        "primary-selected-hover-color": "#003844",
        "brand-colors": {
          "brand-color": "#007f9b",
          "brand-hover-color": "#006278",
          "text-color-on-brand": "#ffffff"
        }
      },
      "black": {
        "primary-color": "#007f9b",
        "primary-hover-color": "#006278",
        "primary-selected-color": "#004858",
        "primary-selected-hover-color": "#003844",
        "brand-colors": {
          "brand-color": "#007f9b",
          "brand-hover-color": "#006278",
          "text-color-on-brand": "#ffffff"
        }
      }
    }
  },
  "boardId": 4213911112,
  "pulseId": 4213911289,
  "itemId": 4213911289,
  "theme": "light", // or "dark" or "black"
  "subscription": { // app subscription object for marketplace app
    "plan_id": "5",
    "renewal_date": "2023-07-10T00:00:00+00:00",
    "is_trial": false,
    "billing_period": "monthly",
    "days_left": 14,
    "pricing_version": 5,
    "max_units": 100 // maximum number of seats allowed for seat-based plans, null for feature-based plans
  },
  "account": { "id": "1233" },
  "user": {
    "id": "28659824",
    "isAdmin": false,
    "isGuest": false,
    "isViewOnly": false,
    "countryCode": "IL",
    "currentLanguage": "en",
    "timeFormat": "12H",
    "timeZoneOffset": 2
  },
  "region": "use1",
  "app": { "id": 10089476, "clientId": "78643ruyagduyg743tyr812uygd74" },
  "appVersion": {
    "id": 10124592,
    "name": "context printer",
    "status": "draft",
    "type": "major",
    "versionData": { "major": 1, "minor": 0, "patch": 0, "type": "major" },
    "mondayCodeHostingUrl": "https://b325b-service-25854030-b5796b91.us.monday.app" // used only for monday code apps; specifies the region-based hosting URL for server-side code
    }, 
  "appFeature": {
    "type": "AppFeatureItemMenuAction",
    "name": "context printer - v1.0.0"
  }
}
Mobile board view
{
  "method": "get",
  "type": "context",
  "data": {
    "themeConfig": {}, // may be "undefined" if the default theme is used, defines the color scheme and styling configuration for the app
    "theme": "light", // or "dark" or "black"
    "account": {
      "id": "5"
    },
    "user": {
      "id": "28659824",
      "isAdmin": false,
      "isGuest": false,
      "isViewOnly": false,
      "countryCode": "US",
      "currentLanguage": "en",
      "timeFormat": "12H", // or 24H
      "timeZoneOffset": 2 // timezone offset based on GMT
    },
    "region": "use1", // availability zone ID
    "boardId": 4213911112, // unique board ID
    "boardIds": [ // list of connected boards
      4213911111
    ],
    "boardViewId": 122234064, // unique board view ID
    "viewMode": "mobile", // not available for item views
    "instanceId": 122234064, // unique instance ID for the feature on the board
    "instanceType": "board_view", // app feature type
    "mode": "mobile", 
    "app": {
      "id": 10089476,
      "clientId": "78643ruyagduyg743tyr812uygd74"
    },
    "appVersion": {
      "id": 10124592,
      "name": "Monday SDK Mobile Dev Playground",
      "status": "live",
      "type": "minor",
            "mondayCodeHostingUrl": "https://b325b-service-25854030-b5796b91.us.monday.app", // used only for monday code apps; specifies the region-based hosting URL for server-side code
      "versionData": {
        "major": 1,
        "minor": 0,
        "patch": 0,
        "number": 31,
        "type": "major",
        "displayNumber": "v31"
      }
    },
    "appFeature": {
      "type": "AppFeatureBoardView",
      "name": "Monday SDK - board view"
    },
    "permissions": {
      "approvedScopes": [
        "me:read",
        "boards:read",
        "boards:write",
        "docs:read",
        "docs:write",
        "workspaces:read",
        "workspaces:write",
        "users:read",
        "users:write",
        "account:read",
        "notifications:write",
        "updates:read",
        "updates:write",
        "assets:read",
        "tags:read",
        "teams:read",
        "teams:write",
        "webhooks:write",
        "webhooks:read"
      ],
      "requiredScopes": [
        "me:read",
        "boards:read",
        "boards:write",
        "docs:read",
        "docs:write",
        "workspaces:read",
        "workspaces:write",
        "users:read",
        "users:write",
        "account:read",
        "notifications:write",
        "updates:read",
        "updates:write",
        "assets:read",
        "tags:read",
        "teams:read",
        "teams:write",
        "webhooks:write",
        "webhooks:read"
      ]
    }
  },
  "requestId": "ABCD"
}
Custom object
{
  "themeConfig": { // may be "undefined" if the default theme is used, defines the color scheme and styling configuration for the app
    "name": "crm-product-theme", 
    "colors": {
      "light": {
        "primary-color": "#007f9b",
        "primary-hover-color": "#006278",
        "primary-selected-color": "#bee3e8",
        "primary-selected-hover-color": "#d4ebef",
        "brand-colors": {
          "brand-color": "#007f9b",
          "brand-hover-color": "#006278",
          "text-color-on-brand": "#ffffff"
        }
      },
      "dark": {
        "primary-color": "#007f9b",
        "primary-hover-color": "#006278",
        "primary-selected-color": "#004858",
        "primary-selected-hover-color": "#003844",
        "brand-colors": {
          "brand-color": "#007f9b",
          "brand-hover-color": "#006278",
          "text-color-on-brand": "#ffffff"
        }
      },
      "black": {
        "primary-color": "#007f9b",
        "primary-hover-color": "#006278",
        "primary-selected-color": "#004858",
        "primary-selected-hover-color": "#003844",
        "brand-colors": {
          "brand-color": "#007f9b",
          "brand-hover-color": "#006278",
          "text-color-on-brand": "#ffffff"
        }
      }
    }
  },
  "boardId": 5562164652,
  "boardIds": [5562164652],
  "workspaceId": 2581779,
  "appFeatureId": 10330058,
  "instanceId": 5562164652,
  "instanceType": "object_view",
  "isFullScreen": false,
  "isPresentingMode": false,
  "objectPermissions": "edit",
  "isFirstLevelControlPinned": true,
  "isSlidePanelOpen": false,
  "boardLoadingState": 10,
  "theme": "light", // or "dark" or "black"
  "subscription": { // app subscription object for marketplace app
    "plan_id": "5",
    "renewal_date": "2023-07-10T00:00:00+00:00",
    "is_trial": false,
    "billing_period": "monthly",
    "days_left": 14,
    "pricing_version": 5,
    "max_units": 100 // maximum number of seats allowed for seat-based plans, null for feature-based plans
  },
  "account": { "id": "1233" },
  "user": {
    "id": "28659824",
    "isAdmin": false,
    "isGuest": false,
    "isViewOnly": false,
    "countryCode": "IL",
    "currentLanguage": "en",
    "timeFormat": "12H",
    "timeZoneOffset": 2
  },
  "region": "use1",
  "app": { "id": 10089476, "clientId": "78643ruyagduyg743tyr812uygd74" },
  "appVersion": {
    "id": 10124592,
    "name": "context printer",
    "status": "draft",
    "type": "major",
    "versionData": { "major": 1, "minor": 0, "patch": 0, "type": "major" },
    "mondayCodeHostingUrl": "https://b325b-service-25854030-b5796b91.us.monday.app" // used only for monday code apps; specifies the region-based hosting URL for server-side code
  },
  "appFeature": {
    "type": "AppFeatureObject",
    "name": "context printer - v1.0.0"
  }
}
Dashboard widget
{
  "themeConfig": { // may be "undefined" if the default theme is used, defines the color scheme and styling configuration for the app
    "name": "crm-product-theme", 
    "colors": {
      "light": {
        "primary-color": "#007f9b",
        "primary-hover-color": "#006278",
        "primary-selected-color": "#bee3e8",
        "primary-selected-hover-color": "#d4ebef",
        "brand-colors": {
          "brand-color": "#007f9b",
          "brand-hover-color": "#006278",
          "text-color-on-brand": "#ffffff"
        }
      },
      "dark": {
        "primary-color": "#007f9b",
        "primary-hover-color": "#006278",
        "primary-selected-color": "#004858",
        "primary-selected-hover-color": "#003844",
        "brand-colors": {
          "brand-color": "#007f9b",
          "brand-hover-color": "#006278",
          "text-color-on-brand": "#ffffff"
        }
      },
      "black": {
        "primary-color": "#007f9b",
        "primary-hover-color": "#006278",
        "primary-selected-color": "#004858",
        "primary-selected-hover-color": "#003844",
        "brand-colors": {
          "brand-color": "#007f9b",
          "brand-hover-color": "#006278",
          "text-color-on-brand": "#ffffff"
        }
      }
    }
  },
  "boardIds": [4213911112], // list of connected boards
  "widgetId": 302536002,
  "viewMode": "widget",
  "editMode": false, // or true
  "instanceId": 302536002,
  "instanceType": "dashboard_widget", // feature type
  "theme": "light", // or "dark" or "black"
  "subscription": { // app subscription object for marketplace app
    "plan_id": "5",
    "renewal_date": "2023-07-10T00:00:00+00:00",
    "is_trial": false,
    "billing_period": "monthly",
    "days_left": 14,
    "pricing_version": 5,
    "max_units": 100 // maximum number of seats allowed for seat-based plans, null for feature-based plans
  },
  "account": { "id": "1233" }, 
  "user": {
    "id": "28659824", 
    "isAdmin": false, // or true
    "isGuest": false, // or true
    "isViewOnly": false, // or true
    "countryCode": "IL",
    "currentLanguage": "en",
    "timeFormat": "12H", // or "24H"
    "timeZoneOffset": 2 // timezone offset based on GMT
  },
  "region": "use1", // availability zone ID
  "app": { "id": 10089476, "clientId": "78643ruyagduyg743tyr812uygd74" }, 
  "appVersion": {
    "id": 10124592, 
    "name": "context printer", 
    "status": "draft", // or "live"
    "type": "major", // or "minor"
    "versionData": { "major": 1, "minor": 0, "patch": 0, "type": "major" },
    "mondayCodeHostingUrl": "https://b325b-service-25854030-b5796b91.us.monday.app" // used only for monday code apps; specifies the region-based hosting URL for server-side code
  },
  "appFeature": {
    "type": "AppFeatureDashboardWidget",
    "name": "context printer - v1.0.0"
  }
}
Doc action
{
  "themeConfig": { // may be "undefined" if the default theme is used, defines the color scheme and styling configuration for the app
    "name": "crm-product-theme", 
    "colors": {
      "light": {
        "primary-color": "#007f9b",
        "primary-hover-color": "#006278",
        "primary-selected-color": "#bee3e8",
        "primary-selected-hover-color": "#d4ebef",
        "brand-colors": {
          "brand-color": "#007f9b",
          "brand-hover-color": "#006278",
          "text-color-on-brand": "#ffffff"
        }
      },
      "dark": {
        "primary-color": "#007f9b",
        "primary-hover-color": "#006278",
        "primary-selected-color": "#004858",
        "primary-selected-hover-color": "#003844",
        "brand-colors": {
          "brand-color": "#007f9b",
          "brand-hover-color": "#006278",
          "text-color-on-brand": "#ffffff"
        }
      },
      "black": {
        "primary-color": "#007f9b",
        "primary-hover-color": "#006278",
        "primary-selected-color": "#004858",
        "primary-selected-hover-color": "#003844",
        "brand-colors": {
          "brand-color": "#007f9b",
          "brand-hover-color": "#006278",
          "text-color-on-brand": "#ffffff"
        }
      }
    }
  },
  "location": "docActionQuickStart",
  "locationContext": {
    "docId": 9230477,
    "objectId": 5562213859,
    "workspaceId": 2581779,
    "additionalSdkMethodsList": ["addMultiBlocksFromHtml", "addMultiBlocks"]
  },
  "appFeatureId": 10330068,
  "withExternalWidth": false,
  "withHeaderPadding": true,
  "docId": 9230477,
  "objectId": 5562213859,
  "workspaceId": 2581779,
  "additionalSdkMethodsList": ["addMultiBlocksFromHtml", "addMultiBlocks"],
  "theme": "light", // or "dark" or "black"
  "subscription": { // app subscription object for marketplace app
    "plan_id": "5",
    "renewal_date": "2023-07-10T00:00:00+00:00",
    "is_trial": false,
    "billing_period": "monthly",
    "days_left": 14,
    "pricing_version": 5,
    "max_units": 100 // maximum number of seats allowed for seat-based plans, null for feature-based plans
  },
  "account": { "id": "1233" },
  "user": {
    "id": "28659824",
    "isAdmin": false,
    "isGuest": false,
    "isViewOnly": false,
    "countryCode": "IL",
    "currentLanguage": "en",
    "timeFormat": "12H",
    "timeZoneOffset": 2
  },
  "region": "use1",
  "app": { "id": 10089476, "clientId": "78643ruyagduyg743tyr812uygd74" },
  "appVersion": {
    "id": 10124592,
    "name": "context printer",
    "status": "draft",
    "type": "major",
    "versionData": { "major": 1, "minor": 0, "patch": 0, "type": "major" },
    "mondayCodeHostingUrl": "https://b325b-service-25854030-b5796b91.us.monday.app" // used only for monday code apps; specifies the region-based hosting URL for server-side code
  },
  "appFeature": {
    "type": "AppFeatureAiDocQuickStart",
    "name": "context printer - v1.0.0"
  }
}
Item view
{
  "theme": "dark", // or "light" or "black"
  "subscription": { // app subscription object for marketplace app
    "plan_id": "5",
    "renewal_date": "2023-07-10T00:00:00+00:00",
    "is_trial": false,
    "billing_period": "monthly",
    "days_left": 14,
    "pricing_version": 5,
    "max_units": 100 // maximum number of seats allowed for seat-based plans, null for feature-based plans
  },
  "account": {
    "id": "654646" // unique account ID
  },
  "user": {
    "id": "65464", // unique user ID
    "isAdmin": false, // or true 
    "isGuest": false, // or true 
    "isViewOnly": false, // or true
    "countryCode": "IL", // user's two-letter country code
    "currentLanguage": "en", // user's default language
    "timeFormat": "24H", // or "12H"
    "timeZoneOffset": 3 // time zone offset based on GMT
  },
  "region": "use1", // availability zone ID
  "productKind": "core",
  "app": {
    "id": 64541082, // unique app ID
    "clientId": "d5be5bbc7re646g76b9988a6ad64d780" // unique client ID
  },
  "appVersion": {
    "id": 6458043, // unique app version ID
    "name": "New App", // name of the app's current version
    "status": "draft", // or "live"
    "type": "major", // or "minor"
    "versionData": {
      "major": 1, // version number
      "minor": 0, // version number
      "patch": 0, // patch number 
      "type": "major" // or "minor"
    },
    "mondayCodeHostingUrl": "https://b325b-service-25854030-b5796b91.us.monday.app" // used only for monday code apps; specifies the region-based hosting URL for server-side code
  },
  "workspaceId": 1350535, // unique workspace ID
  "boardId": 6456619824, // unique board ID
  "boardIds": [
    6454619824 // list of connected boards
  ],
  "itemId": 64564519872, // unique item ID
  "instanceId": 65461164, // unique instance ID for the feature on the board
  "instanceType": "item_view" // feature type
}

Pobieranie listy elementów widocznych na tablicy

Użyj typu itemIds, aby pobrać elementy, które są obecnie widoczne na tablicy. Jeśli użytkownik użyje filtra tablicy, aby ograniczyć wyświetlane rekordy, ta metoda zwróci listę elementów spełniających kryteria filtra.

monday.get("itemIds").then(res => console.log(res));
// => [234234, 1114564, 2324234, 6763375, 5726567]

Pobieranie wyszukiwanego hasła z wyszukiwarki tablicy

Użyj typu filter, aby pobrać wartość wpisaną przez użytkownika w wyszukiwarce tablicy.

monday.get("filter")
  .then(res => console.log(res))
// => { "method":"get", "type":"filter", "data": { "term":"search this" }, "requestId":"vjt8nqrd8" }

Pobieranie adresu URL w aplikacji

SDK umożliwia pobranie wartości lokalizacji w aplikacji. Zwraca ona href, query i search. Możesz też użyć metody SDK monday.listen("location") SDK method, aby nasłuchiwać zmian wartości lokalizacji.

monday.get("location")
  .then(res => console.log(res))
// => { "method":"get", "type":"location", "data": { "href": "https://monday.monday.com/boards/123456789/views/87654321", "query": { "foo": "bar" }, "search": "app[foo]=bar" }

📘 Dołącz do naszej społeczności deweloperów!

Stworzyliśmy społeczność dla deweloperów. Możesz w niej przeszukiwać wcześniejsze dyskusje, aby znaleźć rozwiązania, zadawać pytania, poznawać nowe funkcje i aktualizacje oraz wymieniać się wskazówkami. Dołącz do nas! 😎

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