Skip to main content

Monday full reference

This is the full reference documentation for the Monday agent connector.

Supported entities and actions

The Monday connector supports the following entities and actions.

EntityActions
UsersList, Get, Context Store Search
BoardsList, Get, Context Store Search, Semantic Search
ItemsList, Get, Context Store Search, Semantic Search
TeamsList, Get, Context Store Search
TagsList, Context Store Search
UpdatesList, Get, Context Store Search, Semantic Search
WorkspacesList, Get, Context Store Search
Activity LogsList, Context Store Search

Users

Users List

Returns all users in the Monday.com account

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "users",
"action": "list"
}'

Python SDK

await monday.users.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "users",
"action": "list"
}'

Parameters

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
limitintegerNoNumber of users to return per page (API 2026-07 maximum is 1000)
Response Schema

Records

Field NameTypeDescription
idnull | string
namenull | string
emailnull | string
birthdaynull | string
country_codenull | string
created_atnull | string
kindnull | string
statusnull | string
is_email_confirmednull | boolean
became_active_atnull | string
locationnull | string
mobile_phonenull | string
phonenull | string
photo_urlnull | object
time_zone_identifiernull | string
titlenull | string
urlnull | string
utc_hours_diffnull | number

Users Get

Returns a single user by ID

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "users",
"action": "get",
"params": {
"id": "<str>"
}
}'

Python SDK

await monday.users.get(
id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "users",
"action": "get",
"params": {
"id": "<str>"
}
}'

Parameters

Parameter NameTypeRequiredDescription
idstringYesUser ID

Search and filter users records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "users",
"action": "context_store_search",
"params": {
"query": {
"filter": {
"eq": {
"birthday": "<str>"
}
}
}
}
}'

Python SDK

await monday.users.context_store_search(
query={"filter": {"eq": {"birthday": "<str>"}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "users",
"action": "context_store_search",
"params": {
"query": {"filter": {"eq": {"birthday": "<str>"}}}
}
}'

Parameters

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields

Field NameTypeDescription
birthdaystringUser's birthday
country_codestringUser's country code
created_atstringWhen the user was created
emailstringUser's email address
idstringUnique user identifier
locationstringUser's location
mobile_phonestringUser's mobile phone number
namestringUser's display name
phonestringUser's phone number
time_zone_identifierstringUser's timezone identifier
titlestringUser's job title
urlstringUser's Monday.com profile URL
utc_hours_diffnumberUTC hours difference for the user's timezone (Float under API 2026-07)
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].birthdaystringUser's birthday
data[].country_codestringUser's country code
data[].created_atstringWhen the user was created
data[].emailstringUser's email address
data[].idstringUnique user identifier
data[].locationstringUser's location
data[].mobile_phonestringUser's mobile phone number
data[].namestringUser's display name
data[].phonestringUser's phone number
data[].time_zone_identifierstringUser's timezone identifier
data[].titlestringUser's job title
data[].urlstringUser's Monday.com profile URL
data[].utc_hours_diffnumberUTC hours difference for the user's timezone (Float under API 2026-07)

Boards

Boards List

Returns all boards in the Monday.com account

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "boards",
"action": "list"
}'

Python SDK

await monday.boards.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "boards",
"action": "list"
}'
Response Schema

Records

Field NameTypeDescription
idnull | string
namenull | string
board_kindnull | string
typenull | string
descriptionnull | string
permissionsnull | string
statenull | string
updated_atnull | string
columnsnull | array
groupsnull | array
ownersnull | array
creatornull | object
subscribersnull | array
tagsnull | array
top_groupnull | object
viewsnull | array
workspacenull | object

Boards Get

Returns a single board by ID

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "boards",
"action": "get",
"params": {
"id": "<str>"
}
}'

Python SDK

await monday.boards.get(
id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "boards",
"action": "get",
"params": {
"id": "<str>"
}
}'

Parameters

Parameter NameTypeRequiredDescription
idstringYesBoard ID

Search and filter boards records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "boards",
"action": "context_store_search",
"params": {
"query": {
"filter": {
"eq": {
"board_kind": "<str>"
}
}
}
}
}'

Python SDK

await monday.boards.context_store_search(
query={"filter": {"eq": {"board_kind": "<str>"}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "boards",
"action": "context_store_search",
"params": {
"query": {"filter": {"eq": {"board_kind": "<str>"}}}
}
}'

Parameters

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields

Field NameTypeDescription
board_kindstringBoard kind (public, private, share)
columnsarrayBoard columns
communicationstringBoard communication value
creatorobjectBoard creator
descriptionstringBoard description -- the charter a team writes to say what the board is for. Semantically searchable. Empty on boards created programmatically.
groupsarrayBoard groups
idstringUnique board identifier
namestringBoard name
ownersarrayBoard owners
permissionsstringBoard permissions
statestringBoard state (active, archived, deleted)
subscribersarrayBoard subscribers
tagsarrayBoard tags
top_groupobjectTop group on the board
typestringBoard type
updated_atstringWhen the board was last updated
updated_at_intintegerWhen the board was last updated (Unix timestamp)
updatesarrayBoard updates
viewsarrayBoard views
workspaceobjectWorkspace the board belongs to
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].board_kindstringBoard kind (public, private, share)
data[].columnsarrayBoard columns
data[].communicationstringBoard communication value
data[].creatorobjectBoard creator
data[].descriptionstringBoard description -- the charter a team writes to say what the board is for. Semantically searchable. Empty on boards created programmatically.
data[].groupsarrayBoard groups
data[].idstringUnique board identifier
data[].namestringBoard name
data[].ownersarrayBoard owners
data[].permissionsstringBoard permissions
data[].statestringBoard state (active, archived, deleted)
data[].subscribersarrayBoard subscribers
data[].tagsarrayBoard tags
data[].top_groupobjectTop group on the board
data[].typestringBoard type
data[].updated_atstringWhen the board was last updated
data[].updated_at_intintegerWhen the board was last updated (Unix timestamp)
data[].updatesarrayBoard updates
data[].viewsarrayBoard views
data[].workspaceobjectWorkspace the board belongs to

Search boards records by meaning rather than by exact or fuzzy field values. Semantic search embeds a natural-language prompt and returns the most similar passages, ranked by relevance. Pass semantic={field, prompt, filter?, context_size?, min_similarity?, dedup?} to context_store_search instead of query. Only available in hosted mode.

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "boards",
"action": "context_store_search",
"params": {
"semantic": {"field": "description", "prompt": "<your natural-language query>"}
}
}'

Python SDK

Semantic search is passed through the generic execute method — the typed boards.context_store_search helper only accepts query.

await monday.execute(
"boards",
"context_store_search",
{"semantic": {"field": "description", "prompt": "<your natural-language query>"}},
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "boards",
"action": "context_store_search",
"params": {
"semantic": {"field": "description", "prompt": "<your natural-language query>"}
}
}'

Semantic Parameters

Parameter NameTypeRequiredDescription
semantic.fieldstringYesField to search semantically. Mutually exclusive with query.
semantic.promptstringYesNatural-language query that is embedded and compared against stored passages.
semantic.filterobjectNoFilter conditions (same shape/operators as query.filter). sort is not supported — results are ranked by similarity.
semantic.context_sizeintegerNoCharacters of surrounding context to return per hit, up to the field's configured window. Omit to return the full configured window.
semantic.min_similaritynumberNoMinimum similarity score in [-1.0, 1.0]. Omit for 0.25; scores below the threshold are discarded before deduplication and top-k selection. Use -1.0 to disable the cutoff.
semantic.dedupstringNomax (default) returns the single best-scoring passage per record; none returns multiple passages per record, still ranked by similarity and capped by limit.
fieldsarrayNoField paths to include in results (dot notation for nested fields). Applied to each hit's entity.
limitintegerNoMaximum results to return (default 10, maximum 100).

Semantically Searchable Fields

Field NameMax Context (chars)Description
description2048Board description -- the charter a team writes to say what the board is for. Semantically searchable. Empty on boards created programmatically.
Response Schema
Field NameTypeDescription
dataarrayList of matching passages
data[].entityobjectThe matched source record
data[].entity.idstringSource record field
data[].entity.updated_atstringSource record field
data[].entity.namestringSource record field
data[].entity.statestringSource record field
data[].entity.board_kindstringSource record field
data[].entity.workspace_idstringSource record field
data[].metadataobjectMatch metadata
data[].metadata.scorenumberSimilarity score
data[].metadata.contextstringThe matched passage text
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds

Items

Items List

Returns items from boards. Queries items through the boards endpoint using items_page for pagination.

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "items",
"action": "list",
"params": {
"board_id": "<str>"
}
}'

Python SDK

await monday.items.list(
board_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "items",
"action": "list",
"params": {
"board_id": "<str>"
}
}'

Parameters

Parameter NameTypeRequiredDescription
board_idstringYesBoard ID to fetch items from
Response Schema

Records

Field NameTypeDescription
idnull | string
namenull | string
created_atnull | string
creator_idnull | string
statenull | string
updated_atnull | string
boardnull | object
groupnull | object
parent_itemnull | object
column_valuesnull | array
subscribersnull | array

Items Get

Returns a single item by ID

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "items",
"action": "get",
"params": {
"id": "<str>"
}
}'

Python SDK

await monday.items.get(
id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "items",
"action": "get",
"params": {
"id": "<str>"
}
}'

Parameters

Parameter NameTypeRequiredDescription
idstringYesItem ID

Search and filter items records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "items",
"action": "context_store_search",
"params": {
"query": {
"filter": {
"eq": {
"assets": []
}
}
}
}
}'

Python SDK

await monday.items.context_store_search(
query={"filter": {"eq": {"assets": []}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "items",
"action": "context_store_search",
"params": {
"query": {"filter": {"eq": {"assets": []}}}
}
}'

Parameters

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields

Field NameTypeDescription
assetsarrayFiles attached to the item
boardobjectBoard the item belongs to
column_valuesarrayItem column values
created_atstringWhen the item was created
creator_idstringID of the user who created the item
groupobjectGroup the item belongs to
idstringUnique item identifier
namestringItem name -- the task/row title, and the only always-populated human-readable text on an item. Semantically searchable, prefixed with its board name.
parent_itemobjectParent item (for subitems)
statestringItem state (active, archived, deleted)
subscribersarrayItem subscribers
updated_atstringWhen the item was last updated
updated_at_intintegerWhen the item was last updated (Unix timestamp)
updatesarrayItem updates
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].assetsarrayFiles attached to the item
data[].boardobjectBoard the item belongs to
data[].column_valuesarrayItem column values
data[].created_atstringWhen the item was created
data[].creator_idstringID of the user who created the item
data[].groupobjectGroup the item belongs to
data[].idstringUnique item identifier
data[].namestringItem name -- the task/row title, and the only always-populated human-readable text on an item. Semantically searchable, prefixed with its board name.
data[].parent_itemobjectParent item (for subitems)
data[].statestringItem state (active, archived, deleted)
data[].subscribersarrayItem subscribers
data[].updated_atstringWhen the item was last updated
data[].updated_at_intintegerWhen the item was last updated (Unix timestamp)
data[].updatesarrayItem updates

Search items records by meaning rather than by exact or fuzzy field values. Semantic search embeds a natural-language prompt and returns the most similar passages, ranked by relevance. Pass semantic={field, prompt, filter?, context_size?, min_similarity?, dedup?} to context_store_search instead of query. Only available in hosted mode.

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "items",
"action": "context_store_search",
"params": {
"semantic": {"field": "name", "prompt": "<your natural-language query>"}
}
}'

Python SDK

Semantic search is passed through the generic execute method — the typed items.context_store_search helper only accepts query.

await monday.execute(
"items",
"context_store_search",
{"semantic": {"field": "name", "prompt": "<your natural-language query>"}},
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "items",
"action": "context_store_search",
"params": {
"semantic": {"field": "name", "prompt": "<your natural-language query>"}
}
}'

Semantic Parameters

Parameter NameTypeRequiredDescription
semantic.fieldstringYesField to search semantically. Mutually exclusive with query.
semantic.promptstringYesNatural-language query that is embedded and compared against stored passages.
semantic.filterobjectNoFilter conditions (same shape/operators as query.filter). sort is not supported — results are ranked by similarity.
semantic.context_sizeintegerNoCharacters of surrounding context to return per hit, up to the field's configured window. Omit to return the full configured window.
semantic.min_similaritynumberNoMinimum similarity score in [-1.0, 1.0]. Omit for 0.25; scores below the threshold are discarded before deduplication and top-k selection. Use -1.0 to disable the cutoff.
semantic.dedupstringNomax (default) returns the single best-scoring passage per record; none returns multiple passages per record, still ranked by similarity and capped by limit.
fieldsarrayNoField paths to include in results (dot notation for nested fields). Applied to each hit's entity.
limitintegerNoMaximum results to return (default 10, maximum 100).

Semantically Searchable Fields

Field NameMax Context (chars)Description
name2048Item name -- the task/row title, and the only always-populated human-readable text on an item. Semantically searchable, prefixed with its board name.
Response Schema
Field NameTypeDescription
dataarrayList of matching passages
data[].entityobjectThe matched source record
data[].entity.idstringSource record field
data[].entity.updated_atstringSource record field
data[].entity.namestringSource record field
data[].entity.created_atstringSource record field
data[].entity.creator_idstringSource record field
data[].entity.statestringSource record field
data[].entity.board_idstringSource record field
data[].entity.group_idstringSource record field
data[].metadataobjectMatch metadata
data[].metadata.scorenumberSimilarity score
data[].metadata.contextstringThe matched passage text
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds

Teams

Teams List

Returns all teams in the Monday.com account

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "teams",
"action": "list"
}'

Python SDK

await monday.teams.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "teams",
"action": "list"
}'
Response Schema

Records

Field NameTypeDescription
idnull | string
namenull | string
picture_urlnull | string
usersnull | array

Teams Get

Returns a single team by ID

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "teams",
"action": "get",
"params": {
"id": "<str>"
}
}'

Python SDK

await monday.teams.get(
id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "teams",
"action": "get",
"params": {
"id": "<str>"
}
}'

Parameters

Parameter NameTypeRequiredDescription
idstringYesTeam ID

Search and filter teams records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "teams",
"action": "context_store_search",
"params": {
"query": {
"filter": {
"eq": {
"id": 0
}
}
}
}
}'

Python SDK

await monday.teams.context_store_search(
query={"filter": {"eq": {"id": 0}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "teams",
"action": "context_store_search",
"params": {
"query": {"filter": {"eq": {"id": 0}}}
}
}'

Parameters

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields

Field NameTypeDescription
idintegerUnique team identifier
namestringTeam name
picture_urlstringTeam picture URL
usersarrayTeam members
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].idintegerUnique team identifier
data[].namestringTeam name
data[].picture_urlstringTeam picture URL
data[].usersarrayTeam members

Tags

Tags List

Returns all tags in the Monday.com account

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "tags",
"action": "list"
}'

Python SDK

await monday.tags.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "tags",
"action": "list"
}'
Response Schema

Records

Field NameTypeDescription
idnull | string
namenull | string
colornull | string

Search and filter tags records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "tags",
"action": "context_store_search",
"params": {
"query": {
"filter": {
"eq": {
"color": "<str>"
}
}
}
}
}'

Python SDK

await monday.tags.context_store_search(
query={"filter": {"eq": {"color": "<str>"}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "tags",
"action": "context_store_search",
"params": {
"query": {"filter": {"eq": {"color": "<str>"}}}
}
}'

Parameters

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields

Field NameTypeDescription
colorstringTag color
idstringUnique tag identifier
namestringTag name
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].colorstringTag color
data[].idstringUnique tag identifier
data[].namestringTag name

Updates

Updates List

Returns all updates (comments/posts) in the Monday.com account

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "updates",
"action": "list"
}'

Python SDK

await monday.updates.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "updates",
"action": "list"
}'

Parameters

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
limitintegerNoNumber of updates to return per page
Response Schema

Records

Field NameTypeDescription
idnull | string
bodynull | string
text_bodynull | string
created_atnull | string
creator_idnull | string
item_idnull | string
updated_atnull | string
repliesnull | array
assetsnull | array

Updates Get

Returns a single update by ID

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "updates",
"action": "get",
"params": {
"id": "<str>"
}
}'

Python SDK

await monday.updates.get(
id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "updates",
"action": "get",
"params": {
"id": "<str>"
}
}'

Parameters

Parameter NameTypeRequiredDescription
idstringYesUpdate ID

Search and filter updates records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "updates",
"action": "context_store_search",
"params": {
"query": {
"filter": {
"eq": {
"assets": []
}
}
}
}
}'

Python SDK

await monday.updates.context_store_search(
query={"filter": {"eq": {"assets": []}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "updates",
"action": "context_store_search",
"params": {
"query": {"filter": {"eq": {"assets": []}}}
}
}'

Parameters

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields

Field NameTypeDescription
assetsarrayFiles attached to this update
bodystringUpdate body as HTML. Not semantically indexed -- the embedding engine has no HTML decoder. Use text_body for search; this field is for rendering only.
created_atstringWhen the update was created
creator_idstringID of the user who created the update
idstringUnique update identifier
item_idstringID of the item this update belongs to
repliesarrayReplies to this update -- the threaded discussion beneath it, where the substance of a Monday conversation usually lives. Each reply's plain text is semantically indexed as its own unit; the parent update's text is appended as context.
text_bodystringUpdate body as plain text -- the human comment posted on a Monday item. Semantically searchable. Empty for image-only updates, which therefore produce no embedding.
updated_atstringWhen the update was last modified
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].assetsarrayFiles attached to this update
data[].bodystringUpdate body as HTML. Not semantically indexed -- the embedding engine has no HTML decoder. Use text_body for search; this field is for rendering only.
data[].created_atstringWhen the update was created
data[].creator_idstringID of the user who created the update
data[].idstringUnique update identifier
data[].item_idstringID of the item this update belongs to
data[].repliesarrayReplies to this update -- the threaded discussion beneath it, where the substance of a Monday conversation usually lives. Each reply's plain text is semantically indexed as its own unit; the parent update's text is appended as context.
data[].text_bodystringUpdate body as plain text -- the human comment posted on a Monday item. Semantically searchable. Empty for image-only updates, which therefore produce no embedding.
data[].updated_atstringWhen the update was last modified

Search updates records by meaning rather than by exact or fuzzy field values. Semantic search embeds a natural-language prompt and returns the most similar passages, ranked by relevance. Pass semantic={field, prompt, filter?, context_size?, min_similarity?, dedup?} to context_store_search instead of query. Only available in hosted mode.

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "updates",
"action": "context_store_search",
"params": {
"semantic": {"field": "replies", "prompt": "<your natural-language query>"}
}
}'

Python SDK

Semantic search is passed through the generic execute method — the typed updates.context_store_search helper only accepts query.

await monday.execute(
"updates",
"context_store_search",
{"semantic": {"field": "replies", "prompt": "<your natural-language query>"}},
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "updates",
"action": "context_store_search",
"params": {
"semantic": {"field": "replies", "prompt": "<your natural-language query>"}
}
}'

Semantic Parameters

Parameter NameTypeRequiredDescription
semantic.fieldstringYesField to search semantically. Mutually exclusive with query.
semantic.promptstringYesNatural-language query that is embedded and compared against stored passages.
semantic.filterobjectNoFilter conditions (same shape/operators as query.filter). sort is not supported — results are ranked by similarity.
semantic.context_sizeintegerNoCharacters of surrounding context to return per hit, up to the field's configured window. Omit to return the full configured window.
semantic.min_similaritynumberNoMinimum similarity score in [-1.0, 1.0]. Omit for 0.25; scores below the threshold are discarded before deduplication and top-k selection. Use -1.0 to disable the cutoff.
semantic.dedupstringNomax (default) returns the single best-scoring passage per record; none returns multiple passages per record, still ranked by similarity and capped by limit.
fieldsarrayNoField paths to include in results (dot notation for nested fields). Applied to each hit's entity.
limitintegerNoMaximum results to return (default 10, maximum 100).

Semantically Searchable Fields

Field NameMax Context (chars)Description
replies0Replies to this update -- the threaded discussion beneath it, where the substance of a Monday conversation usually lives. Each reply's plain text is semantically indexed as its own unit; the parent update's text is appended as context.
text_body2048Update body as plain text -- the human comment posted on a Monday item. Semantically searchable. Empty for image-only updates, which therefore produce no embedding.

Each result is also enriched with the following related fields (returned only; not filterable): itemName, authorName.

Response Schema
Field NameTypeDescription
dataarrayList of matching passages
data[].entityobjectThe matched source record
data[].entity.idstringSource record field
data[].entity.updated_atstringSource record field
data[].entity.created_atstringSource record field
data[].entity.item_idstringSource record field
data[].entity.creator_idstringSource record field
data[].metadataobjectMatch metadata
data[].metadata.scorenumberSimilarity score
data[].metadata.contextstringThe matched passage text
data[].metadata.reply_idstringPer-unit attribution for the matched passage
data[].metadata.reply_creator_idstringPer-unit attribution for the matched passage
data[].metadata.reply_created_atstringPer-unit attribution for the matched passage
data[].metadata.itemNamestringEnriched from a related entity at read time (returned only; not filterable)
data[].metadata.authorNamestringEnriched from a related entity at read time (returned only; not filterable)
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds

Workspaces

Workspaces List

Returns all workspaces in the Monday.com account

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "workspaces",
"action": "list"
}'

Python SDK

await monday.workspaces.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "workspaces",
"action": "list"
}'
Response Schema

Records

Field NameTypeDescription
idnull | string
namenull | string
kindnull | string
descriptionnull | string
statenull | string
created_atnull | string
account_productnull | object
owners_subscribersnull | array
settingsnull | object
team_owners_subscribersnull | array
teams_subscribersnull | array
users_subscribersnull | array

Workspaces Get

Returns a single workspace by ID

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "workspaces",
"action": "get",
"params": {
"id": "<str>"
}
}'

Python SDK

await monday.workspaces.get(
id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "workspaces",
"action": "get",
"params": {
"id": "<str>"
}
}'

Parameters

Parameter NameTypeRequiredDescription
idstringYesWorkspace ID

Search and filter workspaces records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "workspaces",
"action": "context_store_search",
"params": {
"query": {
"filter": {
"eq": {
"account_product": {}
}
}
}
}
}'

Python SDK

await monday.workspaces.context_store_search(
query={"filter": {"eq": {"account_product": {}}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "workspaces",
"action": "context_store_search",
"params": {
"query": {"filter": {"eq": {"account_product": {}}}}
}
}'

Parameters

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields

Field NameTypeDescription
account_productobjectAccount product info
created_atstringWhen the workspace was created
descriptionstringWorkspace description
idstringUnique workspace identifier
kindstringWorkspace kind (open, closed)
namestringWorkspace name
owners_subscribersarrayOwner subscribers
settingsobjectWorkspace settings
statestringWorkspace state
team_owners_subscribersarrayTeam owner subscribers
teams_subscribersarrayTeam subscribers
users_subscribersarrayUser subscribers
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].account_productobjectAccount product info
data[].created_atstringWhen the workspace was created
data[].descriptionstringWorkspace description
data[].idstringUnique workspace identifier
data[].kindstringWorkspace kind (open, closed)
data[].namestringWorkspace name
data[].owners_subscribersarrayOwner subscribers
data[].settingsobjectWorkspace settings
data[].statestringWorkspace state
data[].team_owners_subscribersarrayTeam owner subscribers
data[].teams_subscribersarrayTeam subscribers
data[].users_subscribersarrayUser subscribers

Activity Logs

Activity Logs List

Returns activity logs from boards. Requires a board_id parameter.

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "activity_logs",
"action": "list",
"params": {
"board_id": "<str>"
}
}'

Python SDK

await monday.activity_logs.list(
board_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "activity_logs",
"action": "list",
"params": {
"board_id": "<str>"
}
}'

Parameters

Parameter NameTypeRequiredDescription
board_idstringYesBoard ID to fetch activity logs from
Response Schema

Records

Field NameTypeDescription
idnull | string
eventnull | string
datanull | string
entitynull | string
created_atnull | string
user_idnull | string

Search and filter activity logs records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

CLI

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "activity_logs",
"action": "context_store_search",
"params": {
"query": {
"filter": {
"eq": {
"board_id": 0
}
}
}
}
}'

Python SDK

await monday.activity_logs.context_store_search(
query={"filter": {"eq": {"board_id": 0}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "activity_logs",
"action": "context_store_search",
"params": {
"query": {"filter": {"eq": {"board_id": 0}}}
}
}'

Parameters

Parameter NameTypeRequiredDescription
queryobjectYesFilter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or
query.filterobjectNoFilter conditions
query.sortarrayNoSort conditions
limitintegerNoMaximum results to return (default 1000)
cursorstringNoPagination cursor from previous response's meta.cursor
fieldsarrayNoField paths to include in results

Searchable Fields

Field NameTypeDescription
board_idintegerBoard ID the activity belongs to
created_atstringWhen the activity occurred
created_at_intintegerWhen the activity occurred (Unix timestamp)
datastringEvent data (JSON string)
entitystringEntity type that was affected
eventstringEvent type
idstringUnique activity log identifier
pulse_idintegerItem (pulse) ID the activity belongs to
user_idstringID of the user who performed the action
Response Schema
Field NameTypeDescription
dataarrayList of matching records
metaobjectPagination metadata
meta.has_morebooleanWhether additional pages are available
meta.cursorstring | nullCursor for next page of results
meta.took_msnumber | nullQuery execution time in milliseconds
data[].board_idintegerBoard ID the activity belongs to
data[].created_atstringWhen the activity occurred
data[].created_at_intintegerWhen the activity occurred (Unix timestamp)
data[].datastringEvent data (JSON string)
data[].entitystringEntity type that was affected
data[].eventstringEvent type
data[].idstringUnique activity log identifier
data[].pulse_idintegerItem (pulse) ID the activity belongs to
data[].user_idstringID of the user who performed the action