Dokumentacja dla programistów
Obiekty
Dokumentacja API (rdzeń)Dokumentacja API
Obiekty to podstawowy element interfejsu API platformy. Reprezentują ogólny element na platformie monday.com. Mogą to być tablice, pulpity, przepływy pracy lub inne wyspecjalizowane obiekty.
Zapytania
Pobieranie obiektów
- Zwraca tablicę zawierającą metadane kolekcji obiektów.
- Można je wykonywać tylko bezpośrednio na poziomie głównym. Nie można ich zagnieżdżać w innym zapytaniu.
query {
objects(
limit: 4,
state: ACTIVE,
order_by: CREATED_AT
) {
id
name
owners {
id
name
}
}
}
{
"data": {
"objects": [
{
"id": "OBJECT_ID_1",
"name": "Object 1",
"owners": [
{
"id": "OWNER_ID_1",
"name": "Owner 1"
}
]
},
{
"id": "OBJECT_ID_2",
"name": "Object 2",
"owners": [
{
"id": "OWNER_ID_2",
"name": "Owner 2"
}
]
},
{
"id": "OBJECT_ID_3",
"name": "Object 3",
"owners": [
{
"id": "OWNER_ID_3",
"name": "Owner 3"
}
]
},
{
"id": "OBJECT_ID_4",
"name": "Object 4",
"owners": [
{
"id": "OWNER_ID_4",
"name": "Owner 4"
}
]
}
]
},
"extensions": {
"request_id": "YOUR_REQUEST_ID"
}
}
Argumenty
| Argument | Typ | Opis | Wartości wyliczeniowe |
|---|---|---|---|
| ids | [ID!] |
Unikalne identyfikatory obiektów, które mają posłużyć do filtrowania. | |
| limit | Int |
Liczba obiektów do pobrania. Domyślnie: 25. | |
| object_type_unique_keys | [String!] |
Unikalny identyfikator typu obiektu, który ma posłużyć do filtrowania. Wykonaj zapytanie object_types_unique_keys, aby wyświetlić dostępne typy. |
|
| order_by | OrderBy |
Kolejność zwracania obiektów. | CREATED_ATUSED_AT |
| privacy_kind | PrivacyKind |
Ustawienia widoczności obiektu, które mają posłużyć do filtrowania. | PRIVATEPUBLIC |
| state | ObjectState |
Stan obiektu, który ma posłużyć do filtrowania. | ACTIVEARCHIVEDDELETED |
| workspace_ids | [ID!] |
Unikalne identyfikatory obszarów roboczych, które mają posłużyć do filtrowania. |
Pola
| Pole | Typ | Opis |
|---|---|---|
| creator | String |
Twórca obiektu. |
| description | String |
Opis obiektu. |
| folder_id | String |
Unikalny identyfikator folderu zawierającego obiekt. |
| id | String |
Unikalny identyfikator obiektu. |
| name | String |
Nazwa obiektu. |
| owners | [User!] |
Właściciele obiektu. |
| privacy_kind | String |
Ustawienia widoczności obiektu. |
| state | String |
Stan obiektu. |
| subscribers | [User!] |
Obserwujący obiekt. |
| updated_at | String |
Data ostatniej aktualizacji obiektu. |
| workspace_id | String |
Unikalny identyfikator obszaru roboczego zawierającego obiekt. |
| relations | [ObjectRelation!] |
Relacje obiektu (alias lub zależność). Można je filtrować według kind (ALIAS, DEPENDENCY) i direction (OUTGOING, INCOMING). Dostępne tylko w wersjach 2026-04 i nowszych. |
Mutacje
Tworzenie obiektu
Tworzy obiekt. Zwraca Object.
mutation {
create_object(
name: "New Marketing Campaign"
privacy_kind: PUBLIC
object_type_unique_key: "service::portal-object"
description: "Our Q3 marketing campaign."
folder_id: 9876543210
owner_ids: [12345]
) {
id
name
description
owners {
id
}
}
}
{
"data": {
"create_object": {
"id": "1234567890",
"name": "New Marketing Campaign",
"description": "Our Q3 marketing campaign.",
"owners": [
{
"id": "12345"
}
]
}
},
"extensions": {
"request_id": "YOUR_REQUEST_ID"
}
}
Argumenty
| Argument | Typ | Opis | Wartości wyliczeniowe |
|---|---|---|---|
| description | String |
Opis nowego obiektu. | |
| folder_id | ID |
Unikalny identyfikator folderu, w którym ma zostać utworzony obiekt. | |
| name | String! |
Nazwa nowego obiektu. | |
| object_type_unique_key | String! |
Unikalny identyfikator typu obiektu. Wykonaj zapytanie object_types_unique_keys, aby wyświetlić dostępne typy. |
|
| owner_ids | [ID!] |
Unikalne identyfikatory właścicieli nowego obiektu. | |
| owner_team_ids | [ID!] |
Unikalne identyfikatory zespołów będących właścicielami nowego obiektu. | |
| payload | JSON |
Dane JSON nowego obiektu. | |
| privacy_kind | PrivacyKind! |
Ustawienia widoczności nowego obiektu. | PRIVATEPUBLIC |
| subscriber_ids | [ID!] |
Unikalne identyfikatory osób obserwujących nowy obiekt. | |
| subscriber_team_ids | [ID!] |
Unikalne identyfikatory zespołów obserwujących nowy obiekt. | |
| workspace_id | ID |
Unikalny identyfikator obszaru roboczego, w którym ma zostać utworzony obiekt. | |
| relations | [ObjectRelationInput!] |
Opcjonalne relacje do utworzenia wraz z obiektem. Każda relacja wymaga pól kind (ALIAS lub DEPENDENCY) i target_id, a pole target_object_type jest opcjonalne (domyślna wartość to BOARD). Dostępne tylko w wersjach 2026-04 i nowszych. |
Aktualizowanie obiektu
Aktualizuje obiekt. Zwraca Object.
mutation {
update_object(
id: "12345678",
input: {
description: "Our Q4 marketing campaign.",
name: "New Marketing Campaign"
privacy_kind: PRIVATE
}
) {
name
description
privacy_kind
}
}
{
"data": {
"update_object": {
"name": "New Marketing Campaign",
"description": "Our Q4 marketing campaign.",
"privacy_kind": "private"
}
},
"extensions": {
"request_id": "YOUR_REQUEST_ID"
}
}
Argumenty
| Argument | Typ | Opis | Obsługiwane pola |
|---|---|---|---|
| id | String! |
Unikalny identyfikator obiektu do zaktualizowania. | |
| input | UpdateObjectInput! |
Zaktualizowane właściwości obiektu. | description Stringname Stringprivacy_kind PrivacyKind |
Dodawanie obserwujących do obiektu
Dodaje obserwujących lub właścicieli do istniejącego obiektu. Zwraca Object.
mutation {
add_subscribers_to_object(
id: 12345,
user_ids: [1234567890, 9876543210],
kind: SUBSCRIBER
) {
subscribers {
id
name
}
}
}
{
"data": {
"add_subscribers_to_object": {
"subscribers": [
{
"id": "1234567890",
"name": "Owner 1"
},
{
"id": "9876543210",
"name": "Owner 2"
},
{
"id": "123459876",
"name": "Owner 3"
}
]
}
},
"extensions": {
"request_id": "YOUR_REQUEST_ID"
}
}
Argumenty
| Argument | Typ | Opis | Wartości wyliczeniowe |
|---|---|---|---|
| id | ID! |
Unikalny identyfikator obiektu, do którego mają zostać dodani obserwujący. | |
| kind | SubscriberKind |
Rola przypisywana obserwującym. Domyślna wartość to SUBCRIBER. |
OWNER (uprawnienia do pełnej kontroli)SUBSCRIBER (dostęp tylko do powiadomień) |
Archiwizowanie obiektu
Archiwizuje obiekt. Zwraca Object.
mutation {
archive_object(id: 12345) {
state
name
}
}
{
"data": {
"archive_object": {
"state": "archived",
"name": "Object 3"
}
},
"extensions": {
"request_id": "YOUR_REQUEST_ID"
}
}
Argumenty
| Argument | Typ | Opis |
|---|---|---|
| id | ID! |
Unikalny identyfikator obiektu do archiwizacji. |
Usuwanie obiektu
Trwale usuwa dowolny obiekt. Zwraca Object.
Po usunięciu obiektu masz 30 dni na cofnięcie tej czynności. Po upływie tych pierwszych 30 dni obiekt zostanie trwale usunięty i nie będzie można go odzyskać.
mutation {
delete_object(id: 12345) {
state
name
}
}
{
"data": {
"delete_object": {
"state": "deleted",
"name": "Object 4"
}
},
"extensions": {
"request_id": "YOUR_REQUEST_ID"
}
}
Argumenty
| Argument | Typ | Opis |
|---|---|---|
| id | ID! |
Unikalny identyfikator obiektu do usunięcia. |