This is the full reference documentation for the Monday agent connector.
Supported entities and actions
The Monday connector supports the following entities and actions.
| Entity | Actions |
|---|
| Users | List, Get, Context Store Search, Context Store SQL Query |
| Boards | List, Get, Context Store Search, Context Store SQL Query, Semantic Search |
| Items | List, Get, Context Store Search, Context Store SQL Query, Semantic Search |
| Teams | List, Get, Context Store Search, Context Store SQL Query |
| Tags | List, Context Store Search, Context Store SQL Query |
| Updates | List, Get, Context Store Search, Context Store SQL Query, Semantic Search |
| Workspaces | List, Get, Context Store Search, Context Store SQL Query |
| Activity Logs | List, Context Store Search, Context Store SQL Query |
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 Name | Type | Required | Description |
|---|
page | integer | No | Page number for pagination |
limit | integer | No | Number of users to return per page (API 2026-07 maximum is 1000) |
Response Schema
Records
| Field Name | Type | Description |
|---|
id | null | string | |
name | null | string | |
email | null | string | |
birthday | null | string | |
country_code | null | string | |
created_at | null | string | |
kind | null | string | |
status | null | string | |
is_email_confirmed | null | boolean | |
became_active_at | null | string | |
location | null | string | |
mobile_phone | null | string | |
phone | null | string | |
photo_url | null | object | |
time_zone_identifier | null | string | |
title | null | string | |
url | null | string | |
utc_hours_diff | null | 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 Name | Type | Required | Description |
|---|
id | string | Yes | User ID |
Users Context Store Search
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 Name | Type | Required | Description |
|---|
query | object | Yes | Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or |
query.filter | object | No | Filter conditions |
query.sort | array | No | Sort conditions |
limit | integer | No | Maximum results to return (default 1000) |
cursor | string | No | Pagination cursor from previous response's meta.cursor |
fields | array | No | Field paths to include in results |
Searchable Fields
| Field Name | Type | Description |
|---|
birthday | string | User's birthday |
country_code | string | User's country code |
created_at | string | When the user was created |
email | string | User's email address |
id | string | Unique user identifier |
location | string | User's location |
mobile_phone | string | User's mobile phone number |
name | string | User's display name |
phone | string | User's phone number |
time_zone_identifier | string | User's timezone identifier |
title | string | User's job title |
url | string | User's Monday.com profile URL |
utc_hours_diff | number | UTC hours difference for the user's timezone (Float under API 2026-07) |
Response Schema
| Field Name | Type | Description |
|---|
data | array | List of matching records |
meta | object | Pagination metadata |
meta.has_more | boolean | Whether additional pages are available |
meta.cursor | string | null | Cursor for next page of results |
meta.took_ms | number | null | Query execution time in milliseconds |
data[].birthday | string | User's birthday |
data[].country_code | string | User's country code |
data[].created_at | string | When the user was created |
data[].email | string | User's email address |
data[].id | string | Unique user identifier |
data[].location | string | User's location |
data[].mobile_phone | string | User's mobile phone number |
data[].name | string | User's display name |
data[].phone | string | User's phone number |
data[].time_zone_identifier | string | User's timezone identifier |
data[].title | string | User's job title |
data[].url | string | User's Monday.com profile URL |
data[].utc_hours_diff | number | UTC hours difference for the user's timezone (Float under API 2026-07) |
Users Context Store SQL Query
Run a SQL query against users records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.
Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.
CLI
airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "users",
"action": "context_store_sql_query",
"params": {
"sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
}
}'
Python SDK
await monday.users.context_store_sql_query(
sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)
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_sql_query",
"params": {
"sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
}
}'
Parameters
| Parameter Name | Type | Required | Description |
|---|
sql | string | Yes | SQL query to execute against this entity's Context Store data |
limit | integer | No | Maximum results to return |
Response Schema
| Field Name | Type | Description |
|---|
data | array | Projected rows, with dictionary keys matching the selected columns |
meta | object | Query metadata |
meta.has_more | boolean | Whether the result was limited and more rows are available |
meta.cursor | null | SQL query results do not use cursor pagination |
meta.took_ms | number | null | Query execution time in milliseconds |
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 Name | Type | Description |
|---|
id | null | string | |
name | null | string | |
board_kind | null | string | |
type | null | string | |
description | null | string | |
permissions | null | string | |
state | null | string | |
updated_at | null | string | |
columns | null | array | |
groups | null | array | |
owners | null | array | |
creator | null | object | |
subscribers | null | array | |
tags | null | array | |
top_group | null | object | |
views | null | array | |
workspace | null | 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 Name | Type | Required | Description |
|---|
id | string | Yes | Board ID |
Boards Context Store Search
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 Name | Type | Required | Description |
|---|
query | object | Yes | Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or |
query.filter | object | No | Filter conditions |
query.sort | array | No | Sort conditions |
limit | integer | No | Maximum results to return (default 1000) |
cursor | string | No | Pagination cursor from previous response's meta.cursor |
fields | array | No | Field paths to include in results |
Searchable Fields
| Field Name | Type | Description |
|---|
board_kind | string | Board kind (public, private, share) |
columns | array | Board columns |
communication | string | Board communication value |
creator | object | Board creator |
description | string | Board description -- the charter a team writes to say what the board is for. Semantically searchable. Empty on boards created programmatically. |
groups | array | Board groups |
id | string | Unique board identifier |
name | string | Board name |
owners | array | Board owners |
permissions | string | Board permissions |
state | string | Board state (active, archived, deleted) |
subscribers | array | Board subscribers |
tags | array | Board tags |
top_group | object | Top group on the board |
type | string | Board type |
updated_at | string | When the board was last updated |
updated_at_int | integer | When the board was last updated (Unix timestamp) |
updates | array | Board updates |
views | array | Board views |
workspace | object | Workspace the board belongs to |
Response Schema
| Field Name | Type | Description |
|---|
data | array | List of matching records |
meta | object | Pagination metadata |
meta.has_more | boolean | Whether additional pages are available |
meta.cursor | string | null | Cursor for next page of results |
meta.took_ms | number | null | Query execution time in milliseconds |
data[].board_kind | string | Board kind (public, private, share) |
data[].columns | array | Board columns |
data[].communication | string | Board communication value |
data[].creator | object | Board creator |
data[].description | string | Board description -- the charter a team writes to say what the board is for. Semantically searchable. Empty on boards created programmatically. |
data[].groups | array | Board groups |
data[].id | string | Unique board identifier |
data[].name | string | Board name |
data[].owners | array | Board owners |
data[].permissions | string | Board permissions |
data[].state | string | Board state (active, archived, deleted) |
data[].subscribers | array | Board subscribers |
data[].tags | array | Board tags |
data[].top_group | object | Top group on the board |
data[].type | string | Board type |
data[].updated_at | string | When the board was last updated |
data[].updated_at_int | integer | When the board was last updated (Unix timestamp) |
data[].updates | array | Board updates |
data[].views | array | Board views |
data[].workspace | object | Workspace the board belongs to |
Boards Context Store SQL Query
Run a SQL query against boards records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.
Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.
CLI
airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "boards",
"action": "context_store_sql_query",
"params": {
"sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
}
}'
Python SDK
await monday.boards.context_store_sql_query(
sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)
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_sql_query",
"params": {
"sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
}
}'
Parameters
| Parameter Name | Type | Required | Description |
|---|
sql | string | Yes | SQL query to execute against this entity's Context Store data |
limit | integer | No | Maximum results to return |
Response Schema
| Field Name | Type | Description |
|---|
data | array | Projected rows, with dictionary keys matching the selected columns |
meta | object | Query metadata |
meta.has_more | boolean | Whether the result was limited and more rows are available |
meta.cursor | null | SQL query results do not use cursor pagination |
meta.took_ms | number | null | Query execution time in milliseconds |
Boards Semantic Search
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 Name | Type | Required | Description |
|---|
semantic.field | string | Yes | Field to search semantically. Mutually exclusive with query. |
semantic.prompt | string | Yes | Natural-language query that is embedded and compared against stored passages. |
semantic.filter | object | No | Filter conditions (same shape/operators as query.filter). sort is not supported — results are ranked by similarity. |
semantic.context_size | integer | No | Characters of surrounding context to return per hit, up to the field's configured window. Omit to return the full configured window. |
semantic.min_similarity | number | No | Minimum 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.dedup | string | No | max (default) returns the single best-scoring passage per record; none returns multiple passages per record, still ranked by similarity and capped by limit. |
fields | array | No | Field paths to include in results (dot notation for nested fields). Applied to each hit's entity. |
limit | integer | No | Maximum results to return (default 10, maximum 100). |
Semantically Searchable Fields
| Field Name | Max Context (chars) | Description |
|---|
description | 2048 | Board description -- the charter a team writes to say what the board is for. Semantically searchable. Empty on boards created programmatically. |
Response Schema
| Field Name | Type | Description |
|---|
data | array | List of matching passages |
data[].entity | object | The matched source record |
data[].entity.id | string | Source record field |
data[].entity.updated_at | string | Source record field |
data[].entity.name | string | Source record field |
data[].entity.state | string | Source record field |
data[].entity.board_kind | string | Source record field |
data[].entity.workspace_id | string | Source record field |
data[].metadata | object | Match metadata |
data[].metadata.score | number | Similarity score |
data[].metadata.context | string | The matched passage text |
meta | object | Pagination metadata |
meta.has_more | boolean | Whether additional pages are available |
meta.cursor | string | null | Cursor for next page of results |
meta.took_ms | number | null | Query 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 Name | Type | Required | Description |
|---|
board_id | string | Yes | Board ID to fetch items from |
Response Schema
Records
| Field Name | Type | Description |
|---|
id | null | string | |
name | null | string | |
created_at | null | string | |
creator_id | null | string | |
state | null | string | |
updated_at | null | string | |
board | null | object | |
group | null | object | |
parent_item | null | object | |
column_values | null | array | |
subscribers | null | 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 Name | Type | Required | Description |
|---|
id | string | Yes | Item ID |
Items Context Store Search
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 Name | Type | Required | Description |
|---|
query | object | Yes | Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or |
query.filter | object | No | Filter conditions |
query.sort | array | No | Sort conditions |
limit | integer | No | Maximum results to return (default 1000) |
cursor | string | No | Pagination cursor from previous response's meta.cursor |
fields | array | No | Field paths to include in results |
Searchable Fields
| Field Name | Type | Description |
|---|
assets | array | Files attached to the item |
board | object | Board the item belongs to |
column_values | array | Item column values |
created_at | string | When the item was created |
creator_id | string | ID of the user who created the item |
group | object | Group the item belongs to |
id | string | Unique item identifier |
name | string | Item name -- the task/row title, and the only always-populated human-readable text on an item. Semantically searchable, prefixed with its board name. |
parent_item | object | Parent item (for subitems) |
state | string | Item state (active, archived, deleted) |
subscribers | array | Item subscribers |
updated_at | string | When the item was last updated |
updated_at_int | integer | When the item was last updated (Unix timestamp) |
updates | array | Item updates |
Response Schema
| Field Name | Type | Description |
|---|
data | array | List of matching records |
meta | object | Pagination metadata |
meta.has_more | boolean | Whether additional pages are available |
meta.cursor | string | null | Cursor for next page of results |
meta.took_ms | number | null | Query execution time in milliseconds |
data[].assets | array | Files attached to the item |
data[].board | object | Board the item belongs to |
data[].column_values | array | Item column values |
data[].created_at | string | When the item was created |
data[].creator_id | string | ID of the user who created the item |
data[].group | object | Group the item belongs to |
data[].id | string | Unique item identifier |
data[].name | string | Item 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_item | object | Parent item (for subitems) |
data[].state | string | Item state (active, archived, deleted) |
data[].subscribers | array | Item subscribers |
data[].updated_at | string | When the item was last updated |
data[].updated_at_int | integer | When the item was last updated (Unix timestamp) |
data[].updates | array | Item updates |
Items Context Store SQL Query
Run a SQL query against items records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.
Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.
CLI
airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "items",
"action": "context_store_sql_query",
"params": {
"sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
}
}'
Python SDK
await monday.items.context_store_sql_query(
sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)
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_sql_query",
"params": {
"sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
}
}'
Parameters
| Parameter Name | Type | Required | Description |
|---|
sql | string | Yes | SQL query to execute against this entity's Context Store data |
limit | integer | No | Maximum results to return |
Response Schema
| Field Name | Type | Description |
|---|
data | array | Projected rows, with dictionary keys matching the selected columns |
meta | object | Query metadata |
meta.has_more | boolean | Whether the result was limited and more rows are available |
meta.cursor | null | SQL query results do not use cursor pagination |
meta.took_ms | number | null | Query execution time in milliseconds |
Items Semantic Search
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 Name | Type | Required | Description |
|---|
semantic.field | string | Yes | Field to search semantically. Mutually exclusive with query. |
semantic.prompt | string | Yes | Natural-language query that is embedded and compared against stored passages. |
semantic.filter | object | No | Filter conditions (same shape/operators as query.filter). sort is not supported — results are ranked by similarity. |
semantic.context_size | integer | No | Characters of surrounding context to return per hit, up to the field's configured window. Omit to return the full configured window. |
semantic.min_similarity | number | No | Minimum 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.dedup | string | No | max (default) returns the single best-scoring passage per record; none returns multiple passages per record, still ranked by similarity and capped by limit. |
fields | array | No | Field paths to include in results (dot notation for nested fields). Applied to each hit's entity. |
limit | integer | No | Maximum results to return (default 10, maximum 100). |
Semantically Searchable Fields
| Field Name | Max Context (chars) | Description |
|---|
name | 2048 | Item 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 Name | Type | Description |
|---|
data | array | List of matching passages |
data[].entity | object | The matched source record |
data[].entity.id | string | Source record field |
data[].entity.updated_at | string | Source record field |
data[].entity.name | string | Source record field |
data[].entity.created_at | string | Source record field |
data[].entity.creator_id | string | Source record field |
data[].entity.state | string | Source record field |
data[].entity.board_id | string | Source record field |
data[].entity.group_id | string | Source record field |
data[].metadata | object | Match metadata |
data[].metadata.score | number | Similarity score |
data[].metadata.context | string | The matched passage text |
meta | object | Pagination metadata |
meta.has_more | boolean | Whether additional pages are available |
meta.cursor | string | null | Cursor for next page of results |
meta.took_ms | number | null | Query 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 Name | Type | Description |
|---|
id | null | string | |
name | null | string | |
picture_url | null | string | |
users | null | 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 Name | Type | Required | Description |
|---|
id | string | Yes | Team ID |
Teams Context Store Search
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 Name | Type | Required | Description |
|---|
query | object | Yes | Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or |
query.filter | object | No | Filter conditions |
query.sort | array | No | Sort conditions |
limit | integer | No | Maximum results to return (default 1000) |
cursor | string | No | Pagination cursor from previous response's meta.cursor |
fields | array | No | Field paths to include in results |
Searchable Fields
| Field Name | Type | Description |
|---|
id | integer | Unique team identifier |
name | string | Team name |
picture_url | string | Team picture URL |
users | array | Team members |
Response Schema
| Field Name | Type | Description |
|---|
data | array | List of matching records |
meta | object | Pagination metadata |
meta.has_more | boolean | Whether additional pages are available |
meta.cursor | string | null | Cursor for next page of results |
meta.took_ms | number | null | Query execution time in milliseconds |
data[].id | integer | Unique team identifier |
data[].name | string | Team name |
data[].picture_url | string | Team picture URL |
data[].users | array | Team members |
Teams Context Store SQL Query
Run a SQL query against teams records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.
Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.
CLI
airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "teams",
"action": "context_store_sql_query",
"params": {
"sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
}
}'
Python SDK
await monday.teams.context_store_sql_query(
sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)
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_sql_query",
"params": {
"sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
}
}'
Parameters
| Parameter Name | Type | Required | Description |
|---|
sql | string | Yes | SQL query to execute against this entity's Context Store data |
limit | integer | No | Maximum results to return |
Response Schema
| Field Name | Type | Description |
|---|
data | array | Projected rows, with dictionary keys matching the selected columns |
meta | object | Query metadata |
meta.has_more | boolean | Whether the result was limited and more rows are available |
meta.cursor | null | SQL query results do not use cursor pagination |
meta.took_ms | number | null | Query execution time in milliseconds |
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
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 Name | Type | Description |
|---|
id | null | string | |
name | null | string | |
color | null | string | |
Tags Context Store Search
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 Name | Type | Required | Description |
|---|
query | object | Yes | Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or |
query.filter | object | No | Filter conditions |
query.sort | array | No | Sort conditions |
limit | integer | No | Maximum results to return (default 1000) |
cursor | string | No | Pagination cursor from previous response's meta.cursor |
fields | array | No | Field paths to include in results |
Searchable Fields
| Field Name | Type | Description |
|---|
color | string | Tag color |
id | string | Unique tag identifier |
name | string | Tag name |
Response Schema
| Field Name | Type | Description |
|---|
data | array | List of matching records |
meta | object | Pagination metadata |
meta.has_more | boolean | Whether additional pages are available |
meta.cursor | string | null | Cursor for next page of results |
meta.took_ms | number | null | Query execution time in milliseconds |
data[].color | string | Tag color |
data[].id | string | Unique tag identifier |
data[].name | string | Tag name |
Tags Context Store SQL Query
Run a SQL query against tags records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.
Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.
CLI
airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "tags",
"action": "context_store_sql_query",
"params": {
"sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
}
}'
Python SDK
await monday.tags.context_store_sql_query(
sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)
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_sql_query",
"params": {
"sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
}
}'
Parameters
| Parameter Name | Type | Required | Description |
|---|
sql | string | Yes | SQL query to execute against this entity's Context Store data |
limit | integer | No | Maximum results to return |
Response Schema
| Field Name | Type | Description |
|---|
data | array | Projected rows, with dictionary keys matching the selected columns |
meta | object | Query metadata |
meta.has_more | boolean | Whether the result was limited and more rows are available |
meta.cursor | null | SQL query results do not use cursor pagination |
meta.took_ms | number | null | Query execution time in milliseconds |
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 Name | Type | Required | Description |
|---|
page | integer | No | Page number for pagination |
limit | integer | No | Number of updates to return per page |
Response Schema
Records
| Field Name | Type | Description |
|---|
id | null | string | |
body | null | string | |
text_body | null | string | |
created_at | null | string | |
creator_id | null | string | |
item_id | null | string | |
updated_at | null | string | |
replies | null | array | |
assets | null | 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 Name | Type | Required | Description |
|---|
id | string | Yes | Update ID |
Updates Context Store Search
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 Name | Type | Required | Description |
|---|
query | object | Yes | Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or |
query.filter | object | No | Filter conditions |
query.sort | array | No | Sort conditions |
limit | integer | No | Maximum results to return (default 1000) |
cursor | string | No | Pagination cursor from previous response's meta.cursor |
fields | array | No | Field paths to include in results |
Searchable Fields
| Field Name | Type | Description |
|---|
assets | array | Files attached to this update |
body | string | Update 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_at | string | When the update was created |
creator_id | string | ID of the user who created the update |
id | string | Unique update identifier |
item_id | string | ID of the item this update belongs to |
replies | array | Replies 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_body | string | Update 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_at | string | When the update was last modified |
Response Schema
| Field Name | Type | Description |
|---|
data | array | List of matching records |
meta | object | Pagination metadata |
meta.has_more | boolean | Whether additional pages are available |
meta.cursor | string | null | Cursor for next page of results |
meta.took_ms | number | null | Query execution time in milliseconds |
data[].assets | array | Files attached to this update |
data[].body | string | Update 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_at | string | When the update was created |
data[].creator_id | string | ID of the user who created the update |
data[].id | string | Unique update identifier |
data[].item_id | string | ID of the item this update belongs to |
data[].replies | array | Replies 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_body | string | Update 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_at | string | When the update was last modified |
Updates Context Store SQL Query
Run a SQL query against updates records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.
Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.
CLI
airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "updates",
"action": "context_store_sql_query",
"params": {
"sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
}
}'
Python SDK
await monday.updates.context_store_sql_query(
sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)
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_sql_query",
"params": {
"sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
}
}'
Parameters
| Parameter Name | Type | Required | Description |
|---|
sql | string | Yes | SQL query to execute against this entity's Context Store data |
limit | integer | No | Maximum results to return |
Response Schema
| Field Name | Type | Description |
|---|
data | array | Projected rows, with dictionary keys matching the selected columns |
meta | object | Query metadata |
meta.has_more | boolean | Whether the result was limited and more rows are available |
meta.cursor | null | SQL query results do not use cursor pagination |
meta.took_ms | number | null | Query execution time in milliseconds |
Updates Semantic Search
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 Name | Type | Required | Description |
|---|
semantic.field | string | Yes | Field to search semantically. Mutually exclusive with query. |
semantic.prompt | string | Yes | Natural-language query that is embedded and compared against stored passages. |
semantic.filter | object | No | Filter conditions (same shape/operators as query.filter). sort is not supported — results are ranked by similarity. |
semantic.context_size | integer | No | Characters of surrounding context to return per hit, up to the field's configured window. Omit to return the full configured window. |
semantic.min_similarity | number | No | Minimum 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.dedup | string | No | max (default) returns the single best-scoring passage per record; none returns multiple passages per record, still ranked by similarity and capped by limit. |
fields | array | No | Field paths to include in results (dot notation for nested fields). Applied to each hit's entity. |
limit | integer | No | Maximum results to return (default 10, maximum 100). |
Semantically Searchable Fields
| Field Name | Max Context (chars) | Description |
|---|
replies | 0 | Replies 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_body | 2048 | Update 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 Name | Type | Description |
|---|
data | array | List of matching passages |
data[].entity | object | The matched source record |
data[].entity.id | string | Source record field |
data[].entity.updated_at | string | Source record field |
data[].entity.created_at | string | Source record field |
data[].entity.item_id | string | Source record field |
data[].entity.creator_id | string | Source record field |
data[].metadata | object | Match metadata |
data[].metadata.score | number | Similarity score |
data[].metadata.context | string | The matched passage text |
data[].metadata.reply_id | string | Per-unit attribution for the matched passage |
data[].metadata.reply_creator_id | string | Per-unit attribution for the matched passage |
data[].metadata.reply_created_at | string | Per-unit attribution for the matched passage |
data[].metadata.itemName | string | Enriched from a related entity at read time (returned only; not filterable) |
data[].metadata.authorName | string | Enriched from a related entity at read time (returned only; not filterable) |
meta | object | Pagination metadata |
meta.has_more | boolean | Whether additional pages are available |
meta.cursor | string | null | Cursor for next page of results |
meta.took_ms | number | null | Query 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 Name | Type | Description |
|---|
id | null | string | |
name | null | string | |
kind | null | string | |
description | null | string | |
state | null | string | |
created_at | null | string | |
account_product | null | object | |
owners_subscribers | null | array | |
settings | null | object | |
team_owners_subscribers | null | array | |
teams_subscribers | null | array | |
users_subscribers | null | 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 Name | Type | Required | Description |
|---|
id | string | Yes | Workspace ID |
Workspaces Context Store Search
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 Name | Type | Required | Description |
|---|
query | object | Yes | Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or |
query.filter | object | No | Filter conditions |
query.sort | array | No | Sort conditions |
limit | integer | No | Maximum results to return (default 1000) |
cursor | string | No | Pagination cursor from previous response's meta.cursor |
fields | array | No | Field paths to include in results |
Searchable Fields
| Field Name | Type | Description |
|---|
account_product | object | Account product info |
created_at | string | When the workspace was created |
description | string | Workspace description |
id | string | Unique workspace identifier |
kind | string | Workspace kind (open, closed) |
name | string | Workspace name |
owners_subscribers | array | Owner subscribers |
settings | object | Workspace settings |
state | string | Workspace state |
team_owners_subscribers | array | Team owner subscribers |
teams_subscribers | array | Team subscribers |
users_subscribers | array | User subscribers |
Response Schema
| Field Name | Type | Description |
|---|
data | array | List of matching records |
meta | object | Pagination metadata |
meta.has_more | boolean | Whether additional pages are available |
meta.cursor | string | null | Cursor for next page of results |
meta.took_ms | number | null | Query execution time in milliseconds |
data[].account_product | object | Account product info |
data[].created_at | string | When the workspace was created |
data[].description | string | Workspace description |
data[].id | string | Unique workspace identifier |
data[].kind | string | Workspace kind (open, closed) |
data[].name | string | Workspace name |
data[].owners_subscribers | array | Owner subscribers |
data[].settings | object | Workspace settings |
data[].state | string | Workspace state |
data[].team_owners_subscribers | array | Team owner subscribers |
data[].teams_subscribers | array | Team subscribers |
data[].users_subscribers | array | User subscribers |
Workspaces Context Store SQL Query
Run a SQL query against workspaces records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.
Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.
CLI
airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "workspaces",
"action": "context_store_sql_query",
"params": {
"sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
}
}'
Python SDK
await monday.workspaces.context_store_sql_query(
sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)
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_sql_query",
"params": {
"sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
}
}'
Parameters
| Parameter Name | Type | Required | Description |
|---|
sql | string | Yes | SQL query to execute against this entity's Context Store data |
limit | integer | No | Maximum results to return |
Response Schema
| Field Name | Type | Description |
|---|
data | array | Projected rows, with dictionary keys matching the selected columns |
meta | object | Query metadata |
meta.has_more | boolean | Whether the result was limited and more rows are available |
meta.cursor | null | SQL query results do not use cursor pagination |
meta.took_ms | number | null | Query execution time in milliseconds |
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 Name | Type | Required | Description |
|---|
board_id | string | Yes | Board ID to fetch activity logs from |
Response Schema
Records
| Field Name | Type | Description |
|---|
id | null | string | |
event | null | string | |
data | null | string | |
entity | null | string | |
created_at | null | string | |
user_id | null | string | |
Activity Logs Context Store Search
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 Name | Type | Required | Description |
|---|
query | object | Yes | Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, startswith, endswith, contains, array_contains, fuzzy, keyword, not, and, or |
query.filter | object | No | Filter conditions |
query.sort | array | No | Sort conditions |
limit | integer | No | Maximum results to return (default 1000) |
cursor | string | No | Pagination cursor from previous response's meta.cursor |
fields | array | No | Field paths to include in results |
Searchable Fields
| Field Name | Type | Description |
|---|
board_id | integer | Board ID the activity belongs to |
created_at | string | When the activity occurred |
created_at_int | integer | When the activity occurred (Unix timestamp) |
data | string | Event data (JSON string) |
entity | string | Entity type that was affected |
event | string | Event type |
id | string | Unique activity log identifier |
pulse_id | integer | Item (pulse) ID the activity belongs to |
user_id | string | ID of the user who performed the action |
Response Schema
| Field Name | Type | Description |
|---|
data | array | List of matching records |
meta | object | Pagination metadata |
meta.has_more | boolean | Whether additional pages are available |
meta.cursor | string | null | Cursor for next page of results |
meta.took_ms | number | null | Query execution time in milliseconds |
data[].board_id | integer | Board ID the activity belongs to |
data[].created_at | string | When the activity occurred |
data[].created_at_int | integer | When the activity occurred (Unix timestamp) |
data[].data | string | Event data (JSON string) |
data[].entity | string | Entity type that was affected |
data[].event | string | Event type |
data[].id | string | Unique activity log identifier |
data[].pulse_id | integer | Item (pulse) ID the activity belongs to |
data[].user_id | string | ID of the user who performed the action |
Activity Logs Context Store SQL Query
Run a SQL query against activity logs records in the Airbyte Context Store. SQL projections may return any set of columns, so each result row is a dictionary matching the query's selected fields. Only available in hosted mode.
Use the hosted server documentation to find the qualified Context Store table name and SQL guidance.
CLI
airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "monday",
"entity": "activity_logs",
"action": "context_store_sql_query",
"params": {
"sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
}
}'
Python SDK
await monday.activity_logs.context_store_sql_query(
sql="SELECT * FROM <qualified_context_store_table> LIMIT 100"
)
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_sql_query",
"params": {
"sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
}
}'
Parameters
| Parameter Name | Type | Required | Description |
|---|
sql | string | Yes | SQL query to execute against this entity's Context Store data |
limit | integer | No | Maximum results to return |
Response Schema
| Field Name | Type | Description |
|---|
data | array | Projected rows, with dictionary keys matching the selected columns |
meta | object | Query metadata |
meta.has_more | boolean | Whether the result was limited and more rows are available |
meta.cursor | null | SQL query results do not use cursor pagination |
meta.took_ms | number | null | Query execution time in milliseconds |