Wyszukiwanie
API wyszukiwania monday.com pozwala znajdować elementy, tablice, dokumenty, użytkowników, obszary robocze, aktualizacje i elementy osi czasu na całym koncie. Łączy dopasowywanie słów kluczowych z rozumieniem semantycznym, aby zwracać najbardziej trafne wyniki.
W przeciwieństwie do tradycyjnego zapytania wyszukiwania, które zwraca mieszaną listę wyników, API wyszukiwania korzysta ze struktury przestrzeni nazw - search zwraca obiekt SearchNamespace z osobnymi polami dla każdego typu obiektu. Dzięki temu możesz wyszukiwać kilka typów obiektów w jednym żądaniu i określać dla każdego z nich inne filtry.
Dostępne tylko w wersjach API 2026-07 i nowszych
Zapoznaj się z przewodnikiem Wyszukiwanie na całym koncie, aby poznać dobre praktyki, strategie filtrowania i przykłady pokazujące cały proces.
Zapytania
Wyszukiwanie w różnych typach obiektów
Wymagane zakresy uprawnień zależą od typu obiektu:
| Typ obiektu | Wymagany zakres uprawnień |
|---|---|
items |
boards:read |
boards |
boards:read |
docs |
docs:read |
users |
users:read |
workspaces |
workspaces:read |
updates |
updates:read |
timeline_items |
boards:read |
- Zwraca
SearchNamespace!- obiekt z jednym polem dla każdego typu obiektu. - Można odpytać bezpośrednio w głównym poziomie zapytania.
- W żądaniu podaj tylko pola typów obiektów, których potrzebujesz - pominięcie pola pozwala uniknąć zbędnego przetwarzania.
- Argument
limitw każdym polu dotyczy tylko danego typu obiektu.
Każdy typ obiektu jest dostępny jako pole zwracanego obiektu SearchNamespace. W jednym żądaniu uwzględnij tylko pola tych typów obiektów, które chcesz wyszukać:
query {
search {
items(query: "Q1 planning", limit: 10, board_ids: ["1234567890"]) {
results {
id
indexed_data {
name
board_id
url
}
live_data {
id
name
state
}
}
}
boards(query: "Q1 planning", limit: 10) {
results {
id
indexed_data {
name
url
}
}
}
docs(query: "Q1 planning", limit: 5) {
results {
id
indexed_data {
name
}
}
}
users(query: "Ada", limit: 5) {
results {
id
indexed_data {
name
email
}
}
}
workspaces(query: "Q1 planning", limit: 5) {
results {
id
indexed_data {
name
}
}
}
updates(query: "Q1 planning", limit: 5, board_ids: ["1234567890"]) {
results {
id
indexed_data {
body
creator_id
item_id
board_id
created_at
updated_at
}
live_data {
id
body
}
}
}
timeline_items(query: "kickoff call", limit: 5, type: email) {
results {
id
indexed_data {
title
summary
type
product_kind
item_id
board_id
}
live_data {
id
}
}
}
}
}
Argumenty
Samo zapytanie search nie przyjmuje argumentów. Przekaż je do poszczególnych pól typów obiektów w SearchNamespace.
Argumenty search.items:
| Argument | Typ | Opis |
|---|---|---|
| query | String! |
Tekst zapytania wyszukiwania. |
| limit | Int |
Maksymalna liczba zwracanych wyników. Domyślnie: 10. Maksimum: 20. |
| date_range | CrossEntityDateRangeInput |
Opcjonalnie. Filtruje wyniki według daty utworzenia lub aktualizacji. |
| strategy | SearchStrategy |
Określa kompromis między jakością wyszukiwania a czasem odpowiedzi. Domyślnie: BALANCED. |
| board_ids | [ID!] |
Opcjonalnie. Ogranicza wyszukiwanie elementów do określonych identyfikatorów tablic. |
| workspace_ids | [ID!] |
Opcjonalnie. Ogranicza wyszukiwanie elementów do określonych identyfikatorów obszarów roboczych. |
Argumenty search.boards:
| Argument | Typ | Opis |
|---|---|---|
| query | String! |
Tekst zapytania wyszukiwania. |
| limit | Int |
Maksymalna liczba zwracanych wyników. Domyślnie: 10. Maksimum: 20. |
| date_range | CrossEntityDateRangeInput |
Opcjonalnie. Filtruje wyniki według daty utworzenia lub aktualizacji. |
| strategy | SearchStrategy |
Określa kompromis między jakością wyszukiwania a czasem odpowiedzi. Domyślnie: BALANCED. |
| board_ids | [ID!] |
Opcjonalnie. Ogranicza wyszukiwanie tablic do określonych identyfikatorów tablic. |
| workspace_ids | [ID!] |
Opcjonalnie. Ogranicza wyszukiwanie tablic do określonych identyfikatorów obszarów roboczych. |
Argumenty search.docs:
| Argument | Typ | Opis |
|---|---|---|
| query | String! |
Tekst zapytania wyszukiwania. |
| limit | Int |
Maksymalna liczba zwracanych wyników. Domyślnie: 10. Maksimum: 20. |
| date_range | CrossEntityDateRangeInput |
Opcjonalnie. Filtruje wyniki według daty utworzenia lub aktualizacji. |
| strategy | SearchStrategy |
Określa kompromis między jakością wyszukiwania a czasem odpowiedzi. Domyślnie: BALANCED. |
| ids | [ID!] |
Opcjonalnie. Ogranicza wyszukiwanie dokumentów do określonych identyfikatorów dokumentów. |
| workspace_ids | [ID!] |
Opcjonalnie. Ogranicza wyszukiwanie dokumentów do określonych identyfikatorów obszarów roboczych. |
Argumenty search.users:
Dostępne tylko w wersjach API 2026-10 i nowszych
| Argument | Typ | Opis |
|---|---|---|
| query | String! |
Tekst zapytania wyszukiwania. |
| limit | Int |
Maksymalna liczba zwracanych wyników. Domyślnie: 10. Maksimum: 20. |
| date_range | CrossEntityDateRangeInput |
Opcjonalnie. Filtruje wyniki według daty utworzenia lub aktualizacji. |
| strategy | SearchStrategy |
Określa kompromis między jakością wyszukiwania a czasem odpowiedzi. Domyślnie: BALANCED. |
Argumenty search.workspaces:
| Argument | Typ | Opis |
|---|---|---|
| query | String! |
Tekst zapytania wyszukiwania. |
| limit | Int |
Maksymalna liczba zwracanych wyników. Domyślnie: 10. Maksimum: 20. |
| date_range | CrossEntityDateRangeInput |
Opcjonalnie. Filtruje wyniki według daty utworzenia lub aktualizacji. |
| strategy | SearchStrategy |
Określa kompromis między jakością wyszukiwania a czasem odpowiedzi. Domyślnie: BALANCED. |
Argumenty search.updates:
Dostępne tylko w wersjach API 2026-10 i nowszych
| Argument | Typ | Opis |
|---|---|---|
| query | String! |
Tekst zapytania wyszukiwania. Wyszukiwanie aktualizacji dopasowuje tekst do treści aktualizacji. |
| limit | Int |
Maksymalna liczba zwracanych wyników. Domyślnie: 10. Maksimum: 20. |
| date_range | CrossEntityDateRangeInput |
Opcjonalnie. Filtruje wyniki według daty utworzenia lub aktualizacji. |
| strategy | SearchStrategy |
Obsługiwany ze względu na spójność API. Wyszukiwanie aktualizacji dopasowuje słowa kluczowe do treści aktualizacji. |
| board_ids | [ID!] |
Opcjonalnie. Ogranicza wyszukiwanie aktualizacji do określonych identyfikatorów tablic. |
| creator_ids | [ID!] |
Opcjonalnie. Ogranicza wyszukiwanie aktualizacji do tych utworzonych przez użytkowników o określonych identyfikatorach. |
Argumenty search.timeline_items:
Dostępne tylko w wersjach API 2026-10 i nowszych
| Argument | Typ | Opis |
|---|---|---|
| query | String! |
Tekst zapytania wyszukiwania. Wyszukiwanie elementów osi czasu dopasowuje tekst do tytułu, podsumowania i treści. |
| limit | Int |
Maksymalna liczba zwracanych wyników. Domyślnie: 10. Maksimum: 20. |
| date_range | CrossEntityDateRangeInput |
Opcjonalnie. Filtruje wyniki według daty utworzenia lub aktualizacji. |
| strategy | SearchStrategy |
Obsługiwany ze względu na spójność API. Wyszukiwanie elementów osi czasu dopasowuje słowa kluczowe. |
| board_ids | [ID!] |
Opcjonalnie. Ogranicza wyszukiwanie elementów osi czasu do określonych identyfikatorów tablic. |
| workspace_ids | [ID!] |
Opcjonalnie. Ogranicza wyszukiwanie elementów osi czasu do określonych identyfikatorów obszarów roboczych. |
| item_ids | [ID!] |
Opcjonalnie. Ogranicza wyszukiwanie elementów osi czasu do tych powiązanych z określonymi identyfikatorami elementów. |
| type | TimelineItemKind |
Opcjonalnie. Filtruje według rodzaju elementu osi czasu, np. email lub googleCalendar. |
| product_kind | TimelineItemProductKind |
Opcjonalnie. Filtruje według produktu, z którego pochodzi element osi czasu, np. crm lub service. |
Pola
Każde pole typu obiektu w SearchNamespace zwraca obiekt zawierający wyniki. Obiekt ten ma jedno pole: results.
| Pole | Typ | Opis |
|---|---|---|
search.items |
SearchItemResults! |
Wyniki wyszukiwania elementów. |
search.boards |
SearchBoardResults! |
Wyniki wyszukiwania tablic. |
search.docs |
SearchDocResults! |
Wyniki wyszukiwania dokumentów. |
search.users |
SearchUserResults! |
Wyniki wyszukiwania użytkowników. Dostępne tylko w wersjach API 2026-10 i nowszych. |
search.workspaces |
SearchWorkspaceResults! |
Wyniki wyszukiwania obszarów roboczych. |
search.updates |
SearchUpdateResults! |
Wyniki wyszukiwania aktualizacji. Dostępne tylko w wersjach API 2026-10 i nowszych. |
search.timeline_items |
SearchTimelineItemResults! |
Wyniki wyszukiwania elementów osi czasu. Dostępne tylko w wersjach API 2026-10 i nowszych. |
Każdy wynik z tablicy results zawiera:
| Pole | Typ | Opis |
|---|---|---|
| id | ID! |
Unikalny identyfikator obiektu. |
| indexed_data | SearchIndexedItem! / SearchIndexedBoard! / SearchIndexedDoc! / SearchIndexedUser! / SearchIndexedWorkspace! / SearchIndexedUpdate! / SearchIndexedTimelineItem! |
Dane obiektu zapisane w indeksie wyszukiwania. Są szybko dostępne, ale mogą być nieaktualne. |
| live_data | Item / Board / Document / User / Workspace / Update / TimelineItem |
Najnowsze dane obiektu pobrane z głównego API. Wartość null oznacza, że obiekt został usunięty, osoba wysyłająca żądanie nie ma do niego dostępu albo występuje opóźnienie indeksowania. |
indexed_data a live_data
Pole indexed_data zwraca dane zapisane wcześniej w indeksie - są szybko dostępne, ale mogą być nieaktualne. Pole live_data pobiera pełne dane obiektu z głównego API, wraz z najnowszymi zmianami, ale wydłuża czas odpowiedzi. Użyj indexed_data, gdy liczy się szybkość, a live_data, gdy potrzebujesz aktualnych danych.
Autoryzacja
Autoryzacja jest stosowana automatycznie na podstawie kontekstu uwierzytelnionego użytkownika. Wyniki są ograniczone do elementów, tablic, dokumentów, użytkowników, obszarów roboczych, aktualizacji i elementów osi czasu, do których osoba wysyłająca żądanie ma dostęp. Niedostępne wyniki są pomijane w odpowiedzi.
Limity
| Ograniczenie | Wartość |
|---|---|
| Maksymalna liczba wyników w każdym polu typu obiektu | 20 |
| Limit domyślny | 10 |
Wyniki w każdym typie obiektu są zwracane w kolejności od najbardziej do najmniej trafnych. Nie jest dostępna paginacja oparta na kursorze - zwracane są wszystkie wyniki, do określonego limitu.