Go to appAcademyWhat's new?
Back
Artisan IMG > Monday (monday) (944ba223a5c1b5f4b495708e7cd5ee37)
Monday
OverviewOperations (sample payloads)Operations

Operations (sample payloads)

Main operations
Copy

Archive board
Copy

Archive a board.

Sample Input

1
{
2
    "args": {
3
        "board_id": "1234567890"
4
    },
5
    "fields": {
6
        "id": true,
7
        "name": true,
8
        "state": true,
9
        "board_kind": true,
10
        "description": true,
11
        "items_count": true,
12
        "columns": {
13
            "fields": {
14
                "id": true,
15
                "title": true,
16
                "type": true
17
            }
18
        },
19
        "groups": {
20
            "fields": {
21
                "id": true,
22
                "title": true
23
            }
24
        },
25
        "owner": {
26
            "fields": {
27
                "id": true,
28
                "name": true,
29
                "email": true
30
            }
31
        }
32
    }
33
}

Sample Output

1
{
2
    "data": {
3
        "archive_board": {
4
            "id": "1234567890",
5
            "name": "Project X",
6
            "state": "archived",
7
            "board_kind": "public",
8
            "description": "This board tracks all tasks for Project X",
9
            "items_count": 42,
10
            "columns": [
11
                {
12
                    "id": "col1",
13
                    "title": "Status",
14
                    "type": "status"
15
                },
16
                {
17
                    "id": "col2",
18
                    "title": "Assignee",
19
                    "type": "person"
20
                },
21
                {
22
                    "id": "col3",
23
                    "title": "Due Date",
24
                    "type": "date"
25
                }
26
            ],
27
            "groups": [
28
                {
29
                    "id": "group1",
30
                    "title": "To Do"
31
                },
32
                {
33
                    "id": "group2",
34
                    "title": "In Progress"
35
                },
36
                {
37
                    "id": "group3",
38
                    "title": "Done"
39
                }
40
            ],
41
            "owner": {
42
                "id": "user123",
43
                "name": "John Doe",
44
                "email": "john.doe@example.com"
45
            }
46
        }
47
    }
48
}

Archive item
Copy

Archive an item.

Sample Input

1
{
2
    "board_id": "12345678",
3
    "args": {
4
        "item_id": "987654321"
5
    },
6
    "fields": {
7
        "id": true,
8
        "name": true,
9
        "state": true,
10
        "subscribers": {
11
            "fields": {
12
                "id": true,
13
                "name": true,
14
                "email": true
15
            }
16
        }
17
    }
18
}

Sample Output

1
{
2
    "data": {
3
        "archive_item": {
4
            "id": "987654321",
5
            "name": "Project X",
6
            "state": "archived",
7
            "subscribers": [
8
                {
9
                    "id": "user_123",
10
                    "name": "John Doe",
11
                    "email": "john.doe@example.com"
12
                },
13
                {
14
                    "id": "user_456",
15
                    "name": "Jane Smith",
16
                    "email": "jane.smith@example.com"
17
                }
18
            ]
19
        },
20
        "account_id": 1234567890
21
    }
22
}

Create board
Copy

Create a new board.

Sample Input

1
{
2
    "args": {
3
        "board_name": "Project Management",
4
        "board_kind": "$ENUM$:public",
5
        "description": "A board to manage our team's projects and tasks",
6
        "workspace_id": "1234567890"
7
    },
8
    "fields": {
9
        "id": true,
10
        "name": true,
11
        "board_kind": true,
12
        "description": true,
13
        "state": true,
14
        "workspace_id": true,
15
        "columns": {
16
            "fields": {
17
                "id": true,
18
                "title": true,
19
                "type": true
20
            }
21
        },
22
        "groups": {
23
            "fields": {
24
                "id": true,
25
                "title": true
26
            }
27
        },
28
        "items_count": true
29
    }
30
}

Sample Output

1
{
2
    "data": {
3
        "create_board": {
4
            "id": "1234567",
5
            "name": "Project Management",
6
            "board_kind": "public",
7
            "description": "A board to manage our team's projects and tasks",
8
            "state": "active",
9
            "workspace_id": "1234567890",
10
            "columns": [
11
                {
12
                    "id": "text",
13
                    "title": "Name",
14
                    "type": "text"
15
                },
16
                {
17
                    "id": "status",
18
                    "title": "Status",
19
                    "type": "status"
20
                },
21
                {
22
                    "id": "date",
23
                    "title": "Due Date",
24
                    "type": "date"
25
                }
26
            ],
27
            "groups": [
28
                {
29
                    "id": "topics",
30
                    "title": "To Do"
31
                },
32
                {
33
                    "id": "group_1234",
34
                    "title": "In Progress"
35
                },
36
                {
37
                    "id": "group_5678",
38
                    "title": "Done"
39
                }
40
            ],
41
            "items_count": 0
42
        }
43
    }
44
}

Create column
Copy

Create a new column in board.

Sample Input

1
{
2
    "args": {
3
        "board_id": "1234567890",
4
        "title": "Project Status",
5
        "description": "Current status of the project",
6
        "column_type": "$ENUM$:status",
7
        "defaults": "{\"labels\": {\"0\": \"Not Started\", \"1\": \"In Progress\", \"2\": \"Completed\"}}",
8
        "id": "project_status_column",
9
        "after_column_id": "9876543210"
10
    },
11
    "fields": {
12
        "archived": true,
13
        "description": true,
14
        "id": true,
15
        "settings_str": true,
16
        "title": true,
17
        "type": true,
18
        "width": true
19
    }
20
}

Sample Output

1
{
2
    "data": {
3
        "create_column": {
4
            "settings_str": "{\"labels\": {\"0\": \"Not Started\", \"1\": \"In Progress\", \"2\": \"Completed\"}}",
5
            "title": "Project Status",
6
            "type": "status",
7
            "width": "130"
8
        }
9
    },
10
    "account_id": 12345
11
}

Create group
Copy

Create a new group in a specific board.

Sample Input

1
{
2
    "args": {
3
        "board_id": 12345,
4
        "group_name": "New Project Tasks"
5
    },
6
    "fields": {
7
        "archived": true,
8
        "color": true,
9
        "deleted": true,
10
        "id": true,
11
        "position": true,
12
        "title": true
13
    }
14
}

Sample Output

1
{
2
    "data": {
3
        "create_group": {
4
            "archived": false,
5
            "color": "#00FF00",
6
            "deleted": false,
7
            "id": "group_123456",
8
            "position": "1",
9
            "title": "New Project Tasks"
10
        }
11
    },
12
    "account_id": 987654
13
}

Create item
Copy

Create a new item.

Sample Input

1
{
2
    "args": {
3
        "item_name": "New Task",
4
        "board_id": "12345678",
5
        "group_id": "topics",
6
        "column_values": [
7
            {
8
                "column_id": "status",
9
                "value": {
10
                    "status": "Working on it"
11
                }
12
            },
13
            {
14
                "column_id": "date",
15
                "value": {
16
                    "date": "2023-05-15"
17
                }
18
            },
19
            {
20
                "column_id": "person",
21
                "value": {
22
                    "people": [
23
                        {
24
                            "id": 1234567,
25
                            "kind": "person"
26
                        }
27
                    ]
28
                }
29
            }
30
        ]
31
    },
32
    "create_labels_if_missing": true
33
}

Sample Output

1
{
2
    "data": {
3
        "create_item": {
4
            "id": "987654321",
5
            "name": "New Task",
6
            "created_at": "2023-05-10T14:30:00Z",
7
            "updated_at": "2023-05-10T14:30:00Z",
8
            "creator_id": "1234567",
9
            "state": "active",
10
            "board": {
11
                "id": "12345678",
12
                "name": "Project Board",
13
                "board_kind": "public"
14
            },
15
            "group": {
16
                "id": "topics",
17
                "title": "Topics",
18
                "color": "#037f4c"
19
            },
20
            "column_values": [
21
                {
22
                    "id": "status",
23
                    "text": "Working on it",
24
                    "value": "{\"index\":1,\"post_id\":null,\"changed_at\":\"2023-05-10T14:30:00Z\"}"
25
                },
26
                {
27
                    "id": "date",
28
                    "text": "2023-05-15",
29
                    "value": "{\"date\":\"2023-05-15\",\"changed_at\":\"2023-05-10T14:30:00Z\"}"
30
                },
31
                {
32
                    "id": "person",
33
                    "text": "John Doe",
34
                    "value": "{\"personsAndTeams\":[{\"id\":1234567,\"kind\":\"person\"}],\"changed_at\":\"2023-05-10T14:30:00Z\"}"
35
                }
36
            ],
37
            "creator": {
38
                "id": "1234567",
39
                "name": "John Doe",
40
                "email": "john.doe@example.com"
41
            }
42
        }
43
    },
44
    "account_id": 1234567890
45
}

Create notification
Copy

Create a new notification.

Sample Input

1
{
2
    "args": {
3
        "text": "New project update: Design phase completed",
4
        "user_id": "1234567",
5
        "target_id": "9876543",
6
        "target_type": "$ENUM$:Project"
7
    },
8
    "fields": {
9
        "id": true,
10
        "text": true
11
    }
12
}

Sample Output

1
{
2
    "data": {
3
        "create_notification": {
4
            "id": "not_12345",
5
            "text": "New project update: Design phase completed"
6
        }
7
    },
8
    "account_id": 987654
9
}

Create tag
Copy

Create a new tag or get it if it already exists.

Sample Input

1
{
2
    "args": {
3
        "tag_name": "High Priority",
4
        "board_id": "1234567890"
5
    },
6
    "fields": {
7
        "color": true,
8
        "id": true,
9
        "name": true
10
    }
11
}

Sample Output

1
{
2
    "data": {
3
        "create_or_get_tag": {
4
            "color": "#FF0000",
5
            "id": "tag_12345",
6
            "name": "High Priority"
7
        }
8
    },
9
    "account_id": 9876543210
10
}

Create update
Copy

Create a new update.

Sample Input

1
{
2
    "args": {
3
        "body": "New task update: Completed the first draft of the project proposal.",
4
        "item_id": "1234567890"
5
    },
6
    "fields": {
7
        "body": true,
8
        "created_at": true,
9
        "creator": {
10
            "fields": {
11
                "name": true,
12
                "email": true
13
            }
14
        },
15
        "id": true,
16
        "item_id": true,
17
        "text_body": true
18
    }
19
}

Sample Output

1
{
2
    "data": {
3
        "create_update": {
4
            "body": "<p>New task update: Completed the first draft of the project proposal.</p>",
5
            "created_at": "2023-05-15T14:30:00Z",
6
            "creator": {
7
                "name": "John Doe",
8
                "email": "john.doe@example.com"
9
            },
10
            "id": "987654321",
11
            "item_id": "1234567890",
12
            "text_body": "New task update: Completed the first draft of the project proposal."
13
        }
14
    },
15
    "account_id": 12345
16
}

Delete item
Copy

Delete an item.

Sample Input

1
{
2
    "args": {
3
        "item_id": "1234567890"
4
    },
5
    "fields": {
6
        "id": true,
7
        "name": true,
8
        "state": true,
9
        "created_at": true,
10
        "updated_at": true,
11
        "creator_id": true,
12
        "board": {
13
            "fields": {
14
                "id": true,
15
                "name": true
16
            }
17
        },
18
        "group": {
19
            "fields": {
20
                "id": true,
21
                "title": true
22
            }
23
        }
24
    }
25
}

Sample Output

1
{
2
    "data": {
3
        "delete_item": {
4
            "id": "1234567890",
5
            "name": "Task XYZ",
6
            "state": "deleted",
7
            "created_at": "2023-05-15T10:30:00Z",
8
            "updated_at": "2023-05-20T14:45:00Z",
9
            "creator_id": "987654321",
10
            "board": {
11
                "id": "5678901234",
12
                "name": "Project Alpha"
13
            },
14
            "group": {
15
                "id": "2468013579",
16
                "title": "In Progress"
17
            }
18
        }
19
    },
20
    "account_id": 123456
21
}

Duplicate group
Copy

Duplicate a group.

Sample Input

1
{
2
    "args": {
3
        "board_id": 1234567,
4
        "group_id": "group_abc123",
5
        "group_title": "Duplicated Marketing Tasks",
6
        "add_to_top": true
7
    },
8
    "fields": {
9
        "archived": true,
10
        "color": true,
11
        "deleted": true,
12
        "id": true,
13
        "position": true,
14
        "title": true
15
    }
16
}

Sample Output

1
{
2
    "data": {
3
        "duplicate_group": {
4
            "archived": false,
5
            "color": "#FF7A00",
6
            "deleted": false,
7
            "id": "new_group_xyz789",
8
            "position": "1",
9
            "title": "Duplicated Marketing Tasks"
10
        }
11
    },
12
    "account_id": 12345678
13
}

Get complexity
Copy

Get the complexity data of your queries.

Sample Input

1
{
2
    "fields": {
3
        "after": true,
4
        "before": true,
5
        "query": true,
6
        "reset_in_x_seconds": true
7
    }
8
}

Sample Output

1
{
2
    "data": {
3
        "complexity": {
4
            "after": 4980,
5
            "before": 5000,
6
            "query": 20
7
        }
8
    },
9
    "account_id": 12345678
10
}

Get current user
Copy

Get the connected user's information.

Sample Input

1
{
2
    "fields": {
3
        "account": {
4
            "fields": {
5
                "country_code": true,
6
                "first_day_of_the_week": true,
7
                "id": true,
8
                "logo": true,
9
                "name": true,
10
                "show_timeline_weekends": true,
11
                "slug": true
12
            }
13
        },
14
        "birthday": true,
15
        "country_code": true,
16
        "created_at": true,
17
        "email": true,
18
        "enabled": true,
19
        "id": true,
20
        "is_guest": true,
21
        "join_date": true,
22
        "location": true,
23
        "mobile_phone": true,
24
        "name": true,
25
        "phone": true,
26
        "photo_original": true,
27
        "photo_thumb": true,
28
        "title": true,
29
        "url": true,
30
        "utc_hours_diff": true
31
    }
32
}

Sample Output

1
{
2
    "data": {
3
        "me": {
4
            "enabled": true,
5
            "is_pending": false,
6
            "join_date": "2023-01-15T09:30:00Z",
7
            "is_guest": false,
8
            "photo_thumb": "https://example.com/user_thumb.jpg",
9
            "created_at": "2023-01-15T09:30:00Z",
10
            "name": "John Doe",
11
            "account": {
12
                "first_day_of_the_week": "monday",
13
                "id": "acc_123456",
14
                "logo": "https://example.com/company_logo.png",
15
                "name": "Acme Corporation",
16
                "show_timeline_weekends": true,
17
                "slug": "acme-corp"
18
            },
19
            "phone": "+1 (555) 123-4567",
20
            "url": "https://monday.com/users/john.doe",
21
            "utc_hours_diff": -5,
22
            "mobile_phone": "+1 (555) 987-6543",
23
            "location": "New York, NY",
24
            "country_code": "US",
25
            "title": "Senior Project Manager",
26
            "id": "usr_789012",
27
            "email": "john.doe@example.com",
28
            "birthday": "1985-06-15",
29
            "photo_original": "https://example.com/user_original.jpg"
30
        }
31
    },
32
    "account_id": 987654
33
}

Items page by column values
Copy

Search items by multiple columns and values.

Sample Input

1
{
2
    "args": {
3
        "limit": 25,
4
        "board_id": "1234567890",
5
        "columns": [
6
            {
7
                "column_id": "status",
8
                "column_values": [
9
                    "In Progress",
10
                    "Done"
11
                ]
12
            },
13
            {
14
                "column_id": "priority",
15
                "column_values": [
16
                    "High",
17
                    "Urgent"
18
                ]
19
            }
20
        ],
21
        "cursor": "eyJpZCI6MTIzNDU2Nzg5MH0="
22
    },
23
    "fields": {
24
        "cursor": true,
25
        "items": {
26
            "fields": {
27
                "created_at": true,
28
                "creator_id": true,
29
                "id": true,
30
                "name": true,
31
                "state": true
32
            }
33
        }
34
    }
35
}

Sample Output

1
{
2
    "data": {
3
        "items_page_by_column_values": {
4
            "cursor": "eyJpZCI6MjM0NTY3ODkwMX0=",
5
            "items": [
6
                {
7
                    "created_at": "2023-05-15T10:30:00Z",
8
                    "creator_id": "12345",
9
                    "id": "67890",
10
                    "name": "Implement new feature",
11
                    "state": "active"
12
                },
13
                {
14
                    "created_at": "2023-05-14T14:45:00Z",
15
                    "creator_id": "23456",
16
                    "id": "78901",
17
                    "name": "Fix critical bug",
18
                    "state": "active"
19
                }
20
            ]
21
        }
22
    },
23
    "account_id": 9876543210
24
}

List boards
Copy

Get a collection of boards.

Sample Input

1
{
2
    "args": {
3
        "limit": 10,
4
        "page": 1,
5
        "board_kind": "$ENUM$:public",
6
        "state": "$ENUM$:active",
7
        "order_by": "$ENUM$:created_at"
8
    },
9
    "fields": {
10
        "id": true,
11
        "name": true,
12
        "description": true,
13
        "board_kind": true,
14
        "state": true,
15
        "items_count": true,
16
        "columns": {
17
            "fields": {
18
                "id": true,
19
                "title": true,
20
                "type": true
21
            }
22
        },
23
        "groups": {
24
            "fields": {
25
                "id": true,
26
                "title": true
27
            }
28
        },
29
        "owner": {
30
            "fields": {
31
                "id": true,
32
                "name": true,
33
                "email": true
34
            }
35
        }
36
    }
37
}

Sample Output

1
{
2
    "data": {
3
        "boards": [
4
            {
5
                "id": "1234567890",
6
                "name": "Project Management",
7
                "description": "Board for tracking all our ongoing projects",
8
                "board_kind": "public",
9
                "state": "active",
10
                "items_count": 45,
11
                "columns": [
12
                    {
13
                        "id": "text_column",
14
                        "title": "Task Name",
15
                        "type": "text"
16
                    },
17
                    {
18
                        "id": "status_column",
19
                        "title": "Status",
20
                        "type": "status"
21
                    },
22
                    {
23
                        "id": "date_column",
24
                        "title": "Due Date",
25
                        "type": "date"
26
                    }
27
                ],
28
                "groups": [
29
                    {
30
                        "id": "group1",
31
                        "title": "In Progress"
32
                    },
33
                    {
34
                        "id": "group2",
35
                        "title": "Completed"
36
                    }
37
                ],
38
                "owner": {
39
                    "id": "12345",
40
                    "name": "John Doe",
41
                    "email": "john.doe@example.com"
42
                }
43
            },
44
            {
45
                "id": "0987654321",
46
                "name": "Marketing Campaigns",
47
                "description": "Board for planning and tracking marketing campaigns",
48
                "board_kind": "public",
49
                "state": "active",
50
                "items_count": 30,
51
                "columns": [
52
                    {
53
                        "id": "text_column",
54
                        "title": "Campaign Name",
55
                        "type": "text"
56
                    },
57
                    {
58
                        "id": "status_column",
59
                        "title": "Status",
60
                        "type": "status"
61
                    },
62
                    {
63
                        "id": "date_column",
64
                        "title": "Launch Date",
65
                        "type": "date"
66
                    }
67
                ],
68
                "groups": [
69
                    {
70
                        "id": "group1",
71
                        "title": "Planning"
72
                    },
73
                    {
74
                        "id": "group2",
75
                        "title": "Active"
76
                    }
77
                ],
78
                "owner": {
79
                    "id": "67890",
80
                    "name": "Jane Smith",
81
                    "email": "jane.smith@example.com"
82
                }
83
            }
84
        ]
85
    }
86
}

List items
Copy

Get a collection of items.

Sample Input

1
{
2
    "board_id": "1234567890",
3
    "args": {
4
        "limit": 10,
5
        "page": 1,
6
        "newest_first": true,
7
        "exclude_nonactive": true
8
    },
9
    "fields": {
10
        "created_at": true,
11
        "creator_id": true,
12
        "id": true,
13
        "name": true,
14
        "state": true
15
    }
16
}

Sample Output

1
{
2
    "data": {
3
        "items": [
4
            {
5
                "created_at": "2023-05-15T10:30:00Z",
6
                "creator_id": "user_123456",
7
                "id": "item_987654",
8
                "name": "Project A",
9
                "state": "active"
10
            },
11
            {
12
                "created_at": "2023-05-14T15:45:00Z",
13
                "creator_id": "user_234567",
14
                "id": "item_876543",
15
                "name": "Task B",
16
                "state": "active"
17
            },
18
            {
19
                "created_at": "2023-05-13T09:15:00Z",
20
                "creator_id": "user_345678",
21
                "id": "item_765432",
22
                "name": "Meeting C",
23
                "state": "active"
24
            }
25
        ]
26
    },
27
    "account_id": 9876543210
28
}

List tags
Copy

Get a collection of tags.

Sample Input

1
{
2
    "args": {
3
        "ids": [
4
            "tag1",
5
            "tag2",
6
            "tag3"
7
        ]
8
    },
9
    "fields": {
10
        "color": true,
11
        "id": true,
12
        "name": true
13
    }
14
}

Sample Output

1
{
2
    "data": {
3
        "tags": [
4
            {
5
                "name": "Urgent",
6
                "id": "tag1",
7
                "color": "#FF0000"
8
            },
9
            {
10
                "name": "In Progress",
11
                "id": "tag2",
12
                "color": "#FFA500"
13
            },
14
            {
15
                "name": "Completed",
16
                "id": "tag3",
17
                "color": "#00FF00"
18
            }
19
        ]
20
    },
21
    "account_id": 12345
22
}

List teams
Copy

Get a collection of teams.

Sample Input

1
{
2
    "args": {
3
        "ids": [
4
            "team_123",
5
            "team_456"
6
        ]
7
    },
8
    "fields": {
9
        "id": true,
10
        "name": true,
11
        "picture_url": true,
12
        "users": {
13
            "args": {
14
                "limit": 5,
15
                "page": 1
16
            },
17
            "fields": {
18
                "id": true,
19
                "name": true,
20
                "email": true
21
            }
22
        }
23
    }
24
}

Sample Output

1
{
2
    "data": {
3
        "teams": [
4
            {
5
                "id": "team_123",
6
                "name": "Marketing Team",
7
                "picture_url": "https://example.com/team_123_picture.jpg",
8
                "users": {
9
                    "ids": [
10
                        "user_1",
11
                        "user_2",
12
                        "user_3",
13
                        "user_4",
14
                        "user_5"
15
                    ],
16
                    "limit": 5,
17
                    "page": 1
18
                }
19
            },
20
            {
21
                "id": "team_456",
22
                "name": "Development Team",
23
                "picture_url": "https://example.com/team_456_picture.jpg",
24
                "users": {
25
                    "ids": [
26
                        "user_6",
27
                        "user_7",
28
                        "user_8",
29
                        "user_9",
30
                        "user_10"
31
                    ],
32
                    "limit": 5,
33
                    "page": 1
34
                }
35
            }
36
        ],
37
        "account_id": 12345
38
    }
39
}

List updates
Copy

Get a collection of updates.

Sample Input

1
{
2
    "args": {
3
        "limit": 2,
4
        "page": 1,
5
        "ids": [
6
            "12345",
7
            "67890"
8
        ]
9
    },
10
    "fields": {
11
        "body": true,
12
        "created_at": true,
13
        "creator": {
14
            "fields": {
15
                "name": true,
16
                "email": true,
17
                "photo_thumb": true
18
            }
19
        },
20
        "id": true,
21
        "item_id": true,
22
        "text_body": true,
23
        "updated_at": true
24
    }
25
}

Sample Output

1
{
2
    "data": {
3
        "updates": [
4
            {
5
                "body": "<p>Just finished the first draft of the project proposal. Please review and provide feedback.</p>",
6
                "created_at": "2023-06-15T10:30:00Z",
7
                "creator": {
8
                    "name": "John Doe",
9
                    "email": "john.doe@example.com",
10
                    "photo_thumb": "https://example.com/photos/johndoe_thumb.jpg"
11
                },
12
                "id": "12345",
13
                "item_id": "98765",
14
                "text_body": "Just finished the first draft of the project proposal. Please review and provide feedback.",
15
                "updated_at": "2023-06-15T10:30:00Z"
16
            },
17
            {
18
                "body": "<p>Team meeting scheduled for tomorrow at 2 PM. Don't forget to prepare your weekly updates.</p>",
19
                "created_at": "2023-06-14T16:45:00Z",
20
                "creator": {
21
                    "name": "Jane Smith",
22
                    "email": "jane.smith@example.com",
23
                    "photo_thumb": "https://example.com/photos/janesmith_thumb.jpg"
24
                },
25
                "id": "67890",
26
                "item_id": "54321",
27
                "text_body": "Team meeting scheduled for tomorrow at 2 PM. Don't forget to prepare your weekly updates.",
28
                "updated_at": "2023-06-14T16:45:00Z"
29
            }
30
        ],
31
        "account_id": 123456
32
    }
33
}

List users
Copy

Get a collection of users.

Sample Input

1
{
2
    "args": {
3
        "limit": 2,
4
        "page": 1,
5
        "kind": "$ENUM$:all",
6
        "newest_first": true
7
    },
8
    "fields": {
9
        "id": true,
10
        "name": true,
11
        "email": true,
12
        "title": true,
13
        "phone": true,
14
        "location": true,
15
        "is_admin": true,
16
        "created_at": true,
17
        "account": {
18
            "fields": {
19
                "id": true,
20
                "name": true
21
            }
22
        }
23
    }
24
}

Sample Output

1
{
2
    "data": {
3
        "users": [
4
            {
5
                "id": "12345678",
6
                "name": "John Doe",
7
                "email": "john.doe@example.com",
8
                "title": "Senior Developer",
9
                "phone": "+1 (555) 123-4567",
10
                "location": "New York, USA",
11
                "is_admin": true,
12
                "created_at": "2023-05-15T10:30:00Z",
13
                "account": {
14
                    "id": "987654",
15
                    "name": "Acme Corporation"
16
                }
17
            },
18
            {
19
                "id": "87654321",
20
                "name": "Jane Smith",
21
                "email": "jane.smith@example.com",
22
                "title": "Project Manager",
23
                "phone": "+1 (555) 987-6543",
24
                "location": "San Francisco, USA",
25
                "is_admin": false,
26
                "created_at": "2023-05-14T14:45:00Z",
27
                "account": {
28
                    "id": "987654",
29
                    "name": "Acme Corporation"
30
                }
31
            }
32
        ]
33
    },
34
    "account_id": 987654
35
}

Move item to group
Copy

Move an item to a different group.

Sample Input

1
{
2
    "board_id": "1234567890",
3
    "args": {
4
        "item_id": "9876543210",
5
        "group_id": "5678901234"
6
    },
7
    "fields": {
8
        "id": true,
9
        "name": true,
10
        "group": {
11
            "fields": {
12
                "id": true,
13
                "title": true
14
            }
15
        },
16
        "board": {
17
            "fields": {
18
                "id": true,
19
                "name": true
20
            }
21
        }
22
    }
23
}

Sample Output

1
{
2
    "data": {
3
        "move_item_to_group": {
4
            "id": "9876543210",
5
            "name": "Project X",
6
            "group": {
7
                "id": "5678901234",
8
                "title": "In Progress"
9
            },
10
            "board": {
11
                "id": "1234567890",
12
                "name": "Development Tasks"
13
            }
14
        }
15
    },
16
    "account_id": 12345
17
}

Update column value
Copy

Change an item's column value.

Sample Input

1
{
2
    "args": {
3
        "item_id": "1234567890",
4
        "column_id": "status",
5
        "board_id": "9876543210",
6
        "value": {
7
            "status": {
8
                "label": "Done"
9
            }
10
        },
11
        "create_labels_if_missing": false
12
    }
13
}

Sample Output

1
{
2
    "data": {
3
        "change_column_value": {
4
            "id": "1234567890",
5
            "name": "Task 1",
6
            "state": "active",
7
            "board": {
8
                "id": "9876543210",
9
                "name": "Project Board"
10
            },
11
            "group": {
12
                "id": "group_123",
13
                "title": "In Progress"
14
            },
15
            "created_at": "2023-05-15T10:30:00Z",
16
            "updated_at": "2023-05-15T14:45:00Z",
17
            "creator_id": "user_456",
18
            "creator": {
19
                "id": "user_456",
20
                "name": "John Doe",
21
                "email": "john.doe@example.com"
22
            }
23
        }
24
    },
25
    "account_id": 12345
26
}

Update multiple column values
Copy

Changes the column values of a specific item.

Sample Input

1
{
2
    "args": {
3
        "board_id": "1234567890",
4
        "item_id": "9876543210",
5
        "column_values": [
6
            {
7
                "column_id": "status",
8
                "value": {
9
                    "status": "Done"
10
                }
11
            },
12
            {
13
                "column_id": "person",
14
                "value": {
15
                    "people": [
16
                        {
17
                            "id": 12345,
18
                            "kind": "person"
19
                        }
20
                    ]
21
                }
22
            },
23
            {
24
                "column_id": "date",
25
                "value": {
26
                    "date": "2023-05-15",
27
                    "time": true
28
                }
29
            }
30
        ],
31
        "create_labels_if_missing": false
32
    }
33
}

Sample Output

1
{
2
    "data": {
3
        "change_multiple_column_values": {
4
            "id": "9876543210",
5
            "name": "Updated Task",
6
            "state": "active",
7
            "board": {
8
                "id": "1234567890",
9
                "name": "Project Board"
10
            },
11
            "group": {
12
                "id": "group_123",
13
                "title": "In Progress"
14
            },
15
            "created_at": "2023-05-01T10:00:00Z",
16
            "updated_at": "2023-05-15T14:30:00Z",
17
            "creator_id": "user_456",
18
            "creator": {
19
                "id": "user_456",
20
                "name": "John Doe",
21
                "email": "john.doe@example.com"
22
            }
23
        }
24
    },
25
    "account_id": 987654
26
}

DDL operations
Copy

List boards (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "id": "1234567890",
4
        "name": "Project Management"
5
    },
6
    {
7
        "id": "2345678901",
8
        "name": "Marketing Campaigns"
9
    },
10
    {
11
        "id": "3456789012",
12
        "name": "Sales Pipeline"
13
    },
14
    {
15
        "id": "4567890123",
16
        "name": "HR Onboarding"
17
    },
18
    {
19
        "id": "5678901234",
20
        "name": "Product Roadmap"
21
    }
22
]

List columns (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "id": "text",
4
        "title": "Text",
5
        "type": "text"
6
    },
7
    {
8
        "id": "person",
9
        "title": "Person",
10
        "type": "person"
11
    },
12
    {
13
        "id": "status",
14
        "title": "Status",
15
        "type": "status"
16
    },
17
    {
18
        "id": "date",
19
        "title": "Date",
20
        "type": "date"
21
    },
22
    {
23
        "id": "numeric",
24
        "title": "Number",
25
        "type": "numeric"
26
    },
27
    {
28
        "id": "timeline",
29
        "title": "Timeline",
30
        "type": "timeline"
31
    },
32
    {
33
        "id": "file",
34
        "title": "File",
35
        "type": "file"
36
    },
37
    {
38
        "id": "checkbox",
39
        "title": "Checkbox",
40
        "type": "checkbox"
41
    },
42
    {
43
        "id": "dropdown",
44
        "title": "Dropdown",
45
        "type": "dropdown"
46
    },
47
    {
48
        "id": "email",
49
        "title": "Email",
50
        "type": "email"
51
    }
52
]

List groups (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "groups": [
3
        {
4
            "id": "1234567890",
5
            "name": "Marketing Team"
6
        },
7
        {
8
            "id": "2345678901",
9
            "name": "Development Team"
10
        },
11
        {
12
            "id": "3456789012",
13
            "name": "Sales Team"
14
        },
15
        {
16
            "id": "4567890123",
17
            "name": "Human Resources"
18
        },
19
        {
20
            "id": "5678901234",
21
            "name": "Executive Team"
22
        }
23
    ]
24
}

List items (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "items": [
3
        {
4
            "id": "1234567890",
5
            "name": "Project Alpha",
6
            "board_id": "987654321"
7
        },
8
        {
9
            "id": "2345678901",
10
            "name": "Task Beta",
11
            "board_id": "987654321"
12
        },
13
        {
14
            "id": "3456789012",
15
            "name": "Issue Gamma",
16
            "board_id": "876543210"
17
        }
18
    ]
19
}

List tags (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "data": {
3
        "tags": [
4
            {
5
                "id": "1234567",
6
                "name": "Urgent",
7
                "color": "#FF0000"
8
            },
9
            {
10
                "id": "2345678",
11
                "name": "In Progress",
12
                "color": "#FFA500"
13
            },
14
            {
15
                "id": "3456789",
16
                "name": "Completed",
17
                "color": "#008000"
18
            },
19
            {
20
                "id": "4567890",
21
                "name": "Low Priority",
22
                "color": "#0000FF"
23
            }
24
        ]
25
    }
26
}

List teams (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "teams": [
3
        {
4
            "id": "12345",
5
            "name": "Marketing Team"
6
        },
7
        {
8
            "id": "67890",
9
            "name": "Development Team"
10
        },
11
        {
12
            "id": "13579",
13
            "name": "Sales Team"
14
        },
15
        {
16
            "id": "24680",
17
            "name": "Customer Support Team"
18
        }
19
    ]
20
}

List users (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "id": 1234567,
4
        "name": "John Doe",
5
        "email": "john.doe@example.com",
6
        "url": "https://monday.com/users/1234567",
7
        "photo_url": "https://example.com/profile_photos/john_doe.jpg",
8
        "title": "Project Manager",
9
        "position": "Team Lead",
10
        "time_zone_identifier": "America/New_York",
11
        "phone": "+1 (555) 123-4567",
12
        "location": "New York, NY",
13
        "status": "active",
14
        "birthday": "1985-05-15",
15
        "is_guest": false,
16
        "join_date": "2020-01-15T09:00:00Z"
17
    },
18
    {
19
        "id": 7654321,
20
        "name": "Jane Smith",
21
        "email": "jane.smith@example.com",
22
        "url": "https://monday.com/users/7654321",
23
        "photo_url": "https://example.com/profile_photos/jane_smith.jpg",
24
        "title": "Software Developer",
25
        "position": "Senior Engineer",
26
        "time_zone_identifier": "Europe/London",
27
        "phone": "+44 20 1234 5678",
28
        "location": "London, UK",
29
        "status": "active",
30
        "birthday": "1990-09-22",
31
        "is_guest": false,
32
        "join_date": "2019-03-01T10:30:00Z"
33
    }
34
]
Previous

Overview

Next

Operations