Fields Reference

The fields used in the MondayClient library directly correspond to the field structure used in monday.com API queries. When you specify fields in this library, they are translated directly into the GraphQL query structure that monday.com’s API expects.

For example, if you request BoardFields.ITEMS, it’s equivalent to requesting id name items_count items_page { cursor items { id name } } in a GraphQL query.

This page documents all premade field options available across different services.

See also

Fields class documentation for information on implementing custom fields.

class BaseFields[source]

Bases: object

Base class providing common functionality for field collections.

This class provides methods for combining field sets and retrieving all available fields from field collection classes.

classmethod combine(*field_sets)[source]

Dynamically combine multiple field sets from a field collection.

Parameters:: *field_sets (str) – Names of field sets to combine (e.g., ‘BASIC’, ‘DETAILED’)
Return type:: Fields
Returns:: Combined Fields instance

Example

>>> fields = BoardFields.combine('BASIC', 'GROUPS', 'USERS')
>>> print(fields)
'id name top_group { id title } groups { id title } creator { id email name } owners { id email name } subscribers { id email name }'

classmethod get_all_fields()[source]

Get all available fields from a field collection.

Automatically discovers all field sets defined as class attributes that are instances of Fields.

Return type:: Fields
Returns:: Combined Fields instance with all field sets

Example

>>> fields = BoardFields.get_all_fields()
>>> print(fields)
'id name board_kind description top_group { id title } groups { id title } items_count items_page { cursor items { id name } } creator { id email name } owners { id email name } subscribers { id email name }'

class BoardFields[source]

Bases: BaseFields

Collection of predefined field sets for board operations.

See also

monday.com API Board fields

BASIC: Fields = Fields('id name')

Returns the following fields:

id: Board’s ID
name: Board’s name

DETAILED: Fields = Fields('id name state board_kind description')

Returns the following fields:

id: Board’s ID
name: Board’s name
state: Board’s state
board_kind: The type of board
description: Board’s description

GROUPS: Fields = Fields('id name top_group { id title } groups { id title }')

Returns the following fields:

id: Board’s ID
name: Board’s name
top_group: The group at the top of the board
- id: Group’s ID
- title: Group’s title
groups: The board’s visible groups
- id: Group’s ID
- title: Group’s title

ITEMS: Fields = Fields('id name items_count items_page { cursor items { id name } }')

Returns the following fields:

id: Board’s ID
name: Board’s name
items_count: The number of items on the board
items: List of all items on the board
- id: Item’s ID
- name: Item’s name

USERS: Fields = Fields('id name creator { id email name } owners { id email name } subscribers { id email name }')

Returns the following fields:

id: Board’s ID
name: Board’s name
creator: The board’s creator
- id: User’s ID
- email: User’s email
- name: User’s name
owners: The board’s owners
- id: User’s ID
- email: User’s email
- name: User’s name
subscribers: The board’s subscribers
- id: User’s ID
- email: User’s email
- name: User’s name