Typeform full reference

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

Supported entities and actions

The Typeform connector supports the following entities and actions.

Entity	Actions
Forms	List, Get, Context Store Search, Context Store SQL Query, Semantic Search
Responses	List, Context Store Search, Context Store SQL Query, Semantic Search
Webhooks	List, Context Store Search, Context Store SQL Query
Workspaces	List, Context Store Search, Context Store SQL Query
Images	List, Context Store Search, Context Store SQL Query
Themes	List, Context Store Search, Context Store SQL Query

Forms

Forms List

Returns a paginated list of forms in the account

CLI

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

Python SDK

await typeform.forms.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": "forms",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number to retrieve
page_size	integer	No	Number of forms per page

Response Schema

Records

Field Name	Type	Description
id	null | string
type	null | string
title	null | string
created_at	null | string
last_updated_at	null | string
published_at	null | string
workspace	null | object
theme	null | object
settings	null | object
welcome_screens	null | array
thankyou_screens	null | array
logic	null | array
fields	null | array
self	null | object
_links	null | object

Meta

Field Name	Type	Description
total_items	null | integer
page_count	null | integer

Forms Get

Retrieves a single form by its ID, including fields, settings, and logic

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "typeform",
  "entity": "forms",
  "action": "get",
  "params": {
    "form_id": "<str>"
  }
}'

Python SDK

await typeform.forms.get(
    form_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": "forms",
    "action": "get",
    "params": {
        "form_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
form_id	string	Yes	Unique ID of the form

Response Schema

Records

Field Name	Type	Description
id	null | string
type	null | string
title	null | string
created_at	null | string
last_updated_at	null | string
published_at	null | string
workspace	null | object
theme	null | object
settings	null | object
welcome_screens	null | array
thankyou_screens	null | array
logic	null | array
fields	null | array
self	null | object
_links	null | object

Forms Context Store Search

Search and filter forms 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": "typeform",
  "entity": "forms",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "_links": {}
        }
      }
    }
  }
}'

Python SDK

await typeform.forms.context_store_search(
    query={"filter": {"eq": {"_links": {}}}}
)

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": "forms",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"_links": {}}}}
    }
}'

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
_links	object	Links to related resources
created_at	string	Date and time when the form was created
fields	array	List of fields within the form
id	string	Unique identifier of the form
last_updated_at	string	Date and time when the form was last updated
logic	array	Logic rules or conditions applied to the form fields
published_at	string	Date and time when the form was published
settings	object	Settings and configurations for the form
thankyou_screens	array	Thank you screen configurations
theme	object	Theme settings for the form
title	string	Title of the form
type	string	Type of the form
welcome_screens	array	Welcome screen configurations
workspace	object	Workspace details where the form belongs

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[]._links	object	Links to related resources
data[].created_at	string	Date and time when the form was created
data[].fields	array	List of fields within the form
data[].id	string	Unique identifier of the form
data[].last_updated_at	string	Date and time when the form was last updated
data[].logic	array	Logic rules or conditions applied to the form fields
data[].published_at	string	Date and time when the form was published
data[].settings	object	Settings and configurations for the form
data[].thankyou_screens	array	Thank you screen configurations
data[].theme	object	Theme settings for the form
data[].title	string	Title of the form
data[].type	string	Type of the form
data[].welcome_screens	array	Welcome screen configurations
data[].workspace	object	Workspace details where the form belongs

Forms Context Store SQL Query

Run a SQL query against forms 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": "typeform",
  "entity": "forms",
  "action": "context_store_sql_query",
  "params": {
    "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
  }
}'

Python SDK

await typeform.forms.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": "forms",
    "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

Forms Semantic Search

Search forms 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": "typeform",
  "entity": "forms",
  "action": "context_store_search",
  "params": {
    "semantic": {"field": "fields", "prompt": "<your natural-language query>"}
  }
}'

Python SDK

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

await typeform.execute(
    "forms",
    "context_store_search",
    {"semantic": {"field": "fields", "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": "forms",
    "action": "context_store_search",
    "params": {
        "semantic": {"field": "fields", "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
fields	2048	List of fields within the form

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.last_updated_at	string	Source record field
data[].entity.title	string	Source record field
data[].entity.created_at	string	Source record field
data[].entity.published_at	string	Source record field
data[].entity.workspace_href	string	Source record field
data[].entity.display_url	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

Responses

Responses List

Returns a paginated list of responses for a given form

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "typeform",
  "entity": "responses",
  "action": "list",
  "params": {
    "form_id": "<str>"
  }
}'

Python SDK

await typeform.responses.list(
    form_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": "responses",
    "action": "list",
    "params": {
        "form_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
form_id	string	Yes	Unique ID of the form
page_size	integer	No	Number of responses per page
since	string	No	Limit responses to those submitted since the specified date/time (ISO 8601 format, e.g. 2021-03-01T00:00:00Z)
until	string	No	Limit responses to those submitted until the specified date/time (ISO 8601 format)
after	string	No	Cursor token for pagination; returns responses after this token
before	string	No	Cursor token for pagination; returns responses before this token
sort	string	No	Sort order for responses, e.g. submitted_at,asc
completed	boolean	No	Filter by completed status (true or false)
query	string	No	Search query to filter responses

Response Schema

Records

Field Name	Type	Description
response_id	null | string
response_type	null | string
landed_at	null | string
landing_id	null | string
submitted_at	null | string
token	null | string
form_id	null | string
metadata	null | object
variables	null | array
hidden	null | object
calculated	null | object
answers	null | array

Meta

Field Name	Type	Description
total_items	null | integer
page_count	null | integer

Responses Context Store Search

Search and filter responses 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": "typeform",
  "entity": "responses",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "answers": []
        }
      }
    }
  }
}'

Python SDK

await typeform.responses.context_store_search(
    query={"filter": {"eq": {"answers": []}}}
)

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": "responses",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"answers": []}}}
    }
}'

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
answers	array	Response data for each question in the form
calculated	object	Calculated data related to the response
form_id	string	ID of the form
hidden	object	Hidden fields in the response
landed_at	string	Timestamp when the respondent landed on the form
landing_id	string	ID of the landing page
metadata	object	Metadata related to the response
response_id	string	ID of the response
response_type	string	Type of the response
submitted_at	string	Timestamp when the response was submitted
token	string	Token associated with the response
variables	array	Variables associated with the response

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[].answers	array	Response data for each question in the form
data[].calculated	object	Calculated data related to the response
data[].form_id	string	ID of the form
data[].hidden	object	Hidden fields in the response
data[].landed_at	string	Timestamp when the respondent landed on the form
data[].landing_id	string	ID of the landing page
data[].metadata	object	Metadata related to the response
data[].response_id	string	ID of the response
data[].response_type	string	Type of the response
data[].submitted_at	string	Timestamp when the response was submitted
data[].token	string	Token associated with the response
data[].variables	array	Variables associated with the response

Responses Context Store SQL Query

Run a SQL query against responses 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": "typeform",
  "entity": "responses",
  "action": "context_store_sql_query",
  "params": {
    "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
  }
}'

Python SDK

await typeform.responses.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": "responses",
    "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

Responses Semantic Search

Search responses 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": "typeform",
  "entity": "responses",
  "action": "context_store_search",
  "params": {
    "semantic": {"field": "answers", "prompt": "<your natural-language query>"}
  }
}'

Python SDK

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

await typeform.execute(
    "responses",
    "context_store_search",
    {"semantic": {"field": "answers", "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": "responses",
    "action": "context_store_search",
    "params": {
        "semantic": {"field": "answers", "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
answers	2048	Response data for each question in the form

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

Response Schema

Field Name	Type	Description
data	array	List of matching passages
data[].entity	object	The matched source record
data[].entity.response_id	string	Source record field
data[].entity.submitted_at	string	Source record field
data[].entity.form_id	string	Source record field
data[].entity.response_type	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.formTitle	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

Webhooks

Webhooks List

Returns webhooks configured for a given form

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "typeform",
  "entity": "webhooks",
  "action": "list",
  "params": {
    "form_id": "<str>"
  }
}'

Python SDK

await typeform.webhooks.list(
    form_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": "webhooks",
    "action": "list",
    "params": {
        "form_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
form_id	string	Yes	Unique ID of the form

Response Schema

Records

Field Name	Type	Description
id	null | string
form_id	null | string
tag	null | string
url	null | string
enabled	null | boolean
verify_ssl	null | boolean
created_at	null | string
updated_at	null | string

Webhooks Context Store Search

Search and filter webhooks 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": "typeform",
  "entity": "webhooks",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "created_at": "<str>"
        }
      }
    }
  }
}'

Python SDK

await typeform.webhooks.context_store_search(
    query={"filter": {"eq": {"created_at": "<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": "webhooks",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"created_at": "<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
created_at	string	Timestamp when the webhook was created
enabled	boolean	Whether the webhook is currently enabled
form_id	string	ID of the form associated with the webhook
id	string	Unique identifier of the webhook
tag	string	Tag to categorize or label the webhook
updated_at	string	Timestamp when the webhook was last updated
url	string	URL where webhook data is sent
verify_ssl	boolean	Whether SSL verification is enforced

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[].created_at	string	Timestamp when the webhook was created
data[].enabled	boolean	Whether the webhook is currently enabled
data[].form_id	string	ID of the form associated with the webhook
data[].id	string	Unique identifier of the webhook
data[].tag	string	Tag to categorize or label the webhook
data[].updated_at	string	Timestamp when the webhook was last updated
data[].url	string	URL where webhook data is sent
data[].verify_ssl	boolean	Whether SSL verification is enforced

Webhooks Context Store SQL Query

Run a SQL query against webhooks 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": "typeform",
  "entity": "webhooks",
  "action": "context_store_sql_query",
  "params": {
    "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
  }
}'

Python SDK

await typeform.webhooks.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": "webhooks",
    "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

Workspaces

Workspaces List

Returns a paginated list of workspaces in the account

CLI

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

Python SDK

await typeform.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"
}'

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number to retrieve
page_size	integer	No	Number of workspaces per page

Response Schema

Records

Field Name	Type	Description
id	null | string
name	null | string
account_id	null | string
default	null | boolean
shared	null | boolean
forms	null | object
self	null | object

Meta

Field Name	Type	Description
total_items	null | integer
page_count	null | integer

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": "typeform",
  "entity": "workspaces",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "account_id": "<str>"
        }
      }
    }
  }
}'

Python SDK

await typeform.workspaces.context_store_search(
    query={"filter": {"eq": {"account_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": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"account_id": "<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
account_id	string	Account ID associated with the workspace
default	boolean	Whether this is the default workspace
forms	object	Information about forms in the workspace
id	string	Unique identifier of the workspace
name	string	Name of the workspace
self	object	Self-referential link
shared	boolean	Whether this workspace is shared

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_id	string	Account ID associated with the workspace
data[].default	boolean	Whether this is the default workspace
data[].forms	object	Information about forms in the workspace
data[].id	string	Unique identifier of the workspace
data[].name	string	Name of the workspace
data[].self	object	Self-referential link
data[].shared	boolean	Whether this workspace is shared

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": "typeform",
  "entity": "workspaces",
  "action": "context_store_sql_query",
  "params": {
    "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
  }
}'

Python SDK

await typeform.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

Images

Images List

Returns a list of images in the account

CLI

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

Python SDK

await typeform.images.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": "images",
    "action": "list"
}'

Response Schema

Records

Field Name	Type	Description
id	null | string
file_name	null | string
src	null | string
width	null | integer
height	null | integer
media_type	null | string
avg_color	null | string
has_alpha	null | boolean
upload_source	null | string

Images Context Store Search

Search and filter images 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": "typeform",
  "entity": "images",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "avg_color": "<str>"
        }
      }
    }
  }
}'

Python SDK

await typeform.images.context_store_search(
    query={"filter": {"eq": {"avg_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": "images",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"avg_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
avg_color	string	Average color of the image
file_name	string	Name of the image file
has_alpha	boolean	Whether the image has an alpha channel
height	integer	Height of the image in pixels
id	string	Unique identifier of the image
media_type	string	MIME type of the image
src	string	URL to access the image
width	integer	Width of the image in pixels

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[].avg_color	string	Average color of the image
data[].file_name	string	Name of the image file
data[].has_alpha	boolean	Whether the image has an alpha channel
data[].height	integer	Height of the image in pixels
data[].id	string	Unique identifier of the image
data[].media_type	string	MIME type of the image
data[].src	string	URL to access the image
data[].width	integer	Width of the image in pixels

Images Context Store SQL Query

Run a SQL query against images 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": "typeform",
  "entity": "images",
  "action": "context_store_sql_query",
  "params": {
    "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
  }
}'

Python SDK

await typeform.images.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": "images",
    "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

Themes

Themes List

Returns a paginated list of themes in the account

CLI

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

Python SDK

await typeform.themes.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": "themes",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number to retrieve
page_size	integer	No	Number of themes per page

Response Schema

Records

Field Name	Type	Description
id	null | string
name	null | string
visibility	null | string
font	null | string
has_transparent_button	null | boolean
rounded_corners	null | string
colors	null | object
background	null | object
fields	null | object
screens	null | object
created_at	null | string
updated_at	null | string

Meta

Field Name	Type	Description
total_items	null | integer
page_count	null | integer

Themes Context Store Search

Search and filter themes 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": "typeform",
  "entity": "themes",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "background": {}
        }
      }
    }
  }
}'

Python SDK

await typeform.themes.context_store_search(
    query={"filter": {"eq": {"background": {}}}}
)

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": "themes",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"background": {}}}}
    }
}'

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
background	object	Background settings for the theme
colors	object	Color settings
created_at	string	Timestamp when the theme was created
fields	object	Field display settings
font	string	Font used in the theme
has_transparent_button	boolean	Whether the theme has a transparent button
id	string	Unique identifier of the theme
name	string	Name of the theme
rounded_corners	string	Rounded corners setting
screens	object	Screen display settings
updated_at	string	Timestamp when the theme was last updated
visibility	string	Visibility setting of the theme

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[].background	object	Background settings for the theme
data[].colors	object	Color settings
data[].created_at	string	Timestamp when the theme was created
data[].fields	object	Field display settings
data[].font	string	Font used in the theme
data[].has_transparent_button	boolean	Whether the theme has a transparent button
data[].id	string	Unique identifier of the theme
data[].name	string	Name of the theme
data[].rounded_corners	string	Rounded corners setting
data[].screens	object	Screen display settings
data[].updated_at	string	Timestamp when the theme was last updated
data[].visibility	string	Visibility setting of the theme

Themes Context Store SQL Query

Run a SQL query against themes 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": "typeform",
  "entity": "themes",
  "action": "context_store_sql_query",
  "params": {
    "sql": "SELECT * FROM <qualified_context_store_table> LIMIT 100"
  }
}'

Python SDK

await typeform.themes.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": "themes",
    "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