Zendesk-Support full reference

This is the full reference documentation for the Zendesk-Support agent connector.

Supported entities and actions

The Zendesk-Support connector supports the following entities and actions.

Entity	Actions
Tickets	List, Create, Get, Update, Context Store Search, Context Store SQL Query
Ticket Comments	Create, List, Context Store Search, Context Store SQL Query, Semantic Search
Ticket Bulk Updates	Create
Deleted Tickets	List, Context Store Search, Context Store SQL Query
Users	List, Create, Get, Update, Context Store Search, Context Store SQL Query
Organizations	List, Get, Context Store Search, Context Store SQL Query
Groups	List, Get, Context Store Search, Context Store SQL Query
Attachments	Get, Download
Ticket Audits	List, List, Context Store Search, Context Store SQL Query
Ticket Metrics	List, Context Store Search, Context Store SQL Query
Ticket Fields	List, Get, Context Store Search, Context Store SQL Query
Brands	List, Get, Context Store Search, Context Store SQL Query
Views	List, Get
Macros	Get, List, Context Store Search, Context Store SQL Query
Triggers	List, Get, Context Store Search, Context Store SQL Query
Automations	List, Get, Context Store Search, Context Store SQL Query
Tags	List, Context Store Search, Context Store SQL Query
Satisfaction Ratings	List, Get, Context Store Search, Context Store SQL Query
Group Memberships	List, Context Store Search, Context Store SQL Query
Organization Memberships	List, Context Store Search, Context Store SQL Query
Sla Policies	List, Get, Context Store Search, Context Store SQL Query
Ticket Forms	List, Get, Context Store Search, Context Store SQL Query
Articles	List, Get, Context Store Search, Context Store SQL Query
Article Attachments	List, Get, Download, Context Store Search, Context Store SQL Query

Tickets

Tickets List

Returns a list of all tickets in your account

CLI

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

Python SDK

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

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number for pagination
external_id	string	No	Lists tickets by external id
sort_by	"assignee" | "assignee.name" | "created_at" | "group" | "id" | "requester" | "requester.name" | "status" | "subject" | "updated_at"	No	Sort field for offset pagination
sort_order	"asc" | "desc"	No	Sort order for offset pagination
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
external_id	string | null
type	string | null
subject	string | null
raw_subject	string | null
description	string
priority	string | null
status	"new" | "open" | "pending" | "hold" | "solved" | "closed"
recipient	string | null
requester_id	integer
submitter_id	integer
assignee_id	integer | null
organization_id	integer | null
group_id	integer | null
collaborator_ids	array<integer>
follower_ids	array<integer>
email_cc_ids	array<integer>
forum_topic_id	integer | null
problem_id	integer | null
has_incidents	boolean
is_public	boolean
due_at	string | null
tags	array<string>
custom_fields	array<object>
satisfaction_rating	object
sharing_agreement_ids	array<integer>
custom_status_id	integer
fields	array<object>
followup_ids	array<integer>
ticket_form_id	integer
brand_id	integer
allow_channelback	boolean
allow_attachments	boolean
from_messaging_channel	boolean
generated_timestamp	integer
result_type	string | null
created_at	string
updated_at	string
via	object

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Tickets Create

Creates a new ticket in Zendesk Support

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "tickets",
  "action": "create",
  "params": {
    "ticket": {
      "subject": "<str>"
    }
  }
}'

Python SDK

await zendesk_support.tickets.create(
    ticket={
        "subject": "<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": "tickets",
    "action": "create",
    "params": {
        "ticket": {
            "subject": "<str>"
        }
    }
}'

Parameters

Parameter Name	Type	Required	Description
ticket	object	Yes	The ticket object to create
ticket.subject	string	Yes	The subject of the ticket
ticket.description	string	No	The initial comment/description body of the ticket (alias for comment.body)
ticket.comment	object	No	An object that defines the initial comment on the ticket
ticket.comment.body	string	No	The body of the comment
ticket.comment.html_body	string	No	The HTML body of the comment
ticket.comment.public	boolean	No	Whether the comment is public (default true)
ticket.type	"problem" | "incident" | "question" | "task"	No	The type of the ticket
ticket.priority	"urgent" | "high" | "normal" | "low"	No	The urgency of the ticket
ticket.status	"new" | "open" | "pending" | "hold" | "solved"	No	The state of the ticket
ticket.requester_id	integer	No	The user who requested this ticket
ticket.assignee_id	integer	No	The agent currently assigned to the ticket
ticket.group_id	integer	No	The group this ticket is assigned to
ticket.organization_id	integer	No	The organization of the requester
ticket.tags	array<string>	No	Tags to apply to the ticket
ticket.external_id	string	No	An external id to link Zendesk Support tickets to local records
ticket.custom_fields	array<object>	No	Custom fields for the ticket
ticket.custom_fields.id	integer	No
ticket.custom_fields.value	string	No
ticket.due_at	string	No	Due date for task-type tickets
ticket.collaborator_ids	array<integer>	No	Users to add as CCs on the ticket

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
external_id	string | null
type	string | null
subject	string | null
raw_subject	string | null
description	string
priority	string | null
status	"new" | "open" | "pending" | "hold" | "solved" | "closed"
recipient	string | null
requester_id	integer
submitter_id	integer
assignee_id	integer | null
organization_id	integer | null
group_id	integer | null
collaborator_ids	array<integer>
follower_ids	array<integer>
email_cc_ids	array<integer>
forum_topic_id	integer | null
problem_id	integer | null
has_incidents	boolean
is_public	boolean
due_at	string | null
tags	array<string>
custom_fields	array<object>
satisfaction_rating	object
sharing_agreement_ids	array<integer>
custom_status_id	integer
fields	array<object>
followup_ids	array<integer>
ticket_form_id	integer
brand_id	integer
allow_channelback	boolean
allow_attachments	boolean
from_messaging_channel	boolean
generated_timestamp	integer
result_type	string | null
created_at	string
updated_at	string
via	object

Tickets Get

Returns a ticket by its ID

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "tickets",
  "action": "get",
  "params": {
    "ticket_id": 0
  }
}'

Python SDK

await zendesk_support.tickets.get(
    ticket_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": "tickets",
    "action": "get",
    "params": {
        "ticket_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
ticket_id	integer	Yes	The ID of the ticket

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
external_id	string | null
type	string | null
subject	string | null
raw_subject	string | null
description	string
priority	string | null
status	"new" | "open" | "pending" | "hold" | "solved" | "closed"
recipient	string | null
requester_id	integer
submitter_id	integer
assignee_id	integer | null
organization_id	integer | null
group_id	integer | null
collaborator_ids	array<integer>
follower_ids	array<integer>
email_cc_ids	array<integer>
forum_topic_id	integer | null
problem_id	integer | null
has_incidents	boolean
is_public	boolean
due_at	string | null
tags	array<string>
custom_fields	array<object>
satisfaction_rating	object
sharing_agreement_ids	array<integer>
custom_status_id	integer
fields	array<object>
followup_ids	array<integer>
ticket_form_id	integer
brand_id	integer
allow_channelback	boolean
allow_attachments	boolean
from_messaging_channel	boolean
generated_timestamp	integer
result_type	string | null
created_at	string
updated_at	string
via	object

Tickets Update

Updates an existing ticket. Can update status, priority, assignee, add comments, and more.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "tickets",
  "action": "update",
  "params": {
    "ticket": {},
    "ticket_id": 0
  }
}'

Python SDK

await zendesk_support.tickets.update(
    ticket={},
    ticket_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": "tickets",
    "action": "update",
    "params": {
        "ticket": {},
        "ticket_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
ticket	object	Yes	The ticket fields to update
ticket.subject	string	No	The subject of the ticket
ticket.comment	object	No	A comment to add to the ticket
ticket.comment.body	string	No	The body of the comment
ticket.comment.html_body	string	No	The HTML body of the comment
ticket.comment.public	boolean	No	Whether the comment is public (true) or an internal note (false)
ticket.comment.author_id	integer	No	The author of the comment
ticket.type	"problem" | "incident" | "question" | "task"	No	The type of the ticket
ticket.priority	"urgent" | "high" | "normal" | "low"	No	The urgency of the ticket
ticket.status	"new" | "open" | "pending" | "hold" | "solved"	No	The state of the ticket
ticket.assignee_id	integer	No	The agent to assign to the ticket
ticket.group_id	integer	No	The group to assign the ticket to
ticket.tags	array<string>	No	Tags for the ticket (replaces existing tags)
ticket.external_id	string	No	An external id to link Zendesk Support tickets to local records
ticket.custom_fields	array<object>	No	Custom fields for the ticket
ticket.custom_fields.id	integer	No
ticket.custom_fields.value	string	No
ticket.due_at	string	No	Due date for task-type tickets
ticket.collaborator_ids	array<integer>	No	Users to set as CCs on the ticket
ticket_id	integer	Yes	The ID of the ticket to update

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
external_id	string | null
type	string | null
subject	string | null
raw_subject	string | null
description	string
priority	string | null
status	"new" | "open" | "pending" | "hold" | "solved" | "closed"
recipient	string | null
requester_id	integer
submitter_id	integer
assignee_id	integer | null
organization_id	integer | null
group_id	integer | null
collaborator_ids	array<integer>
follower_ids	array<integer>
email_cc_ids	array<integer>
forum_topic_id	integer | null
problem_id	integer | null
has_incidents	boolean
is_public	boolean
due_at	string | null
tags	array<string>
custom_fields	array<object>
satisfaction_rating	object
sharing_agreement_ids	array<integer>
custom_status_id	integer
fields	array<object>
followup_ids	array<integer>
ticket_form_id	integer
brand_id	integer
allow_channelback	boolean
allow_attachments	boolean
from_messaging_channel	boolean
generated_timestamp	integer
result_type	string | null
created_at	string
updated_at	string
via	object

Tickets Context Store Search

Search and filter tickets 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": "zendesk-support",
  "entity": "tickets",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "allow_attachments": true
        }
      }
    }
  }
}'

Python SDK

await zendesk_support.tickets.context_store_search(
    query={"filter": {"eq": {"allow_attachments": True}}}
)

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

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
allow_attachments	boolean	Boolean indicating whether attachments are allowed on the ticket
allow_channelback	boolean	Boolean indicating whether agents can reply to the ticket through the original channel
assignee_id	integer	Unique identifier of the agent currently assigned to the ticket
brand_id	integer	Unique identifier of the brand associated with the ticket in multi-brand accounts
collaborator_ids	array	Array of user identifiers who are collaborating on the ticket
created_at	string	Timestamp indicating when the ticket was created
custom_fields	array	Array of custom field values specific to the account's ticket configuration
custom_status_id	integer	Unique identifier of the custom status applied to the ticket
deleted_ticket_form_id	integer	The ID of the ticket form that was previously associated with this ticket but has since been deleted
description	string	Initial description or content of the ticket when it was created
due_at	string	Timestamp indicating when the ticket is due for completion or resolution
email_cc_ids	array	Array of user identifiers who are CC'd on ticket email notifications
external_id	string	External identifier for the ticket, used for integrations with other systems
fields	array	Array of ticket field values including both system and custom fields
follower_ids	array	Array of user identifiers who are following the ticket for updates
followup_ids	array	Array of identifiers for follow-up tickets related to this ticket
forum_topic_id	integer	Unique identifier linking the ticket to a forum topic if applicable
from_messaging_channel	boolean	Boolean indicating whether the ticket originated from a messaging channel
generated_timestamp	integer	Timestamp updated for all ticket updates including system changes, used for incremental export
group_id	integer	Unique identifier of the agent group assigned to handle the ticket
has_incidents	boolean	Boolean indicating whether this problem ticket has related incident tickets
id	integer	Unique identifier for the ticket
is_public	boolean	Boolean indicating whether the ticket is publicly visible
organization_id	integer	Unique identifier of the organization associated with the ticket
priority	string	Priority level assigned to the ticket (e.g., urgent, high, normal, low)
problem_id	integer	Unique identifier of the problem ticket if this is an incident ticket
raw_subject	string	Original unprocessed subject line before any system modifications
recipient	string	Email address or identifier of the ticket recipient
requester_id	integer	Unique identifier of the user who requested or created the ticket
satisfaction_rating	`object	string`
sharing_agreement_ids	array	Array of sharing agreement identifiers if the ticket is shared across Zendesk instances
status	string	Current status of the ticket (e.g., new, open, pending, solved, closed)
subject	string	Subject line of the ticket describing the issue or request
submitter_id	integer	Unique identifier of the user who submitted the ticket on behalf of the requester
tags	array	Array of tags applied to the ticket for categorization and filtering
ticket_form_id	integer	Unique identifier of the ticket form used when creating the ticket
type	string	Type of ticket (e.g., problem, incident, question, task)
updated_at	string	Timestamp indicating when the ticket was last updated with a ticket event
url	string	API URL to access the full ticket resource
result_type	string	The type of the search result (e.g. ticket) when returned from search endpoints
via	object	Object describing the channel and method through which the ticket was created

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[].allow_attachments	boolean	Boolean indicating whether attachments are allowed on the ticket
data[].allow_channelback	boolean	Boolean indicating whether agents can reply to the ticket through the original channel
data[].assignee_id	integer	Unique identifier of the agent currently assigned to the ticket
data[].brand_id	integer	Unique identifier of the brand associated with the ticket in multi-brand accounts
data[].collaborator_ids	array	Array of user identifiers who are collaborating on the ticket
data[].created_at	string	Timestamp indicating when the ticket was created
data[].custom_fields	array	Array of custom field values specific to the account's ticket configuration
data[].custom_status_id	integer	Unique identifier of the custom status applied to the ticket
data[].deleted_ticket_form_id	integer	The ID of the ticket form that was previously associated with this ticket but has since been deleted
data[].description	string	Initial description or content of the ticket when it was created
data[].due_at	string	Timestamp indicating when the ticket is due for completion or resolution
data[].email_cc_ids	array	Array of user identifiers who are CC'd on ticket email notifications
data[].external_id	string	External identifier for the ticket, used for integrations with other systems
data[].fields	array	Array of ticket field values including both system and custom fields
data[].follower_ids	array	Array of user identifiers who are following the ticket for updates
data[].followup_ids	array	Array of identifiers for follow-up tickets related to this ticket
data[].forum_topic_id	integer	Unique identifier linking the ticket to a forum topic if applicable
data[].from_messaging_channel	boolean	Boolean indicating whether the ticket originated from a messaging channel
data[].generated_timestamp	integer	Timestamp updated for all ticket updates including system changes, used for incremental export
data[].group_id	integer	Unique identifier of the agent group assigned to handle the ticket
data[].has_incidents	boolean	Boolean indicating whether this problem ticket has related incident tickets
data[].id	integer	Unique identifier for the ticket
data[].is_public	boolean	Boolean indicating whether the ticket is publicly visible
data[].organization_id	integer	Unique identifier of the organization associated with the ticket
data[].priority	string	Priority level assigned to the ticket (e.g., urgent, high, normal, low)
data[].problem_id	integer	Unique identifier of the problem ticket if this is an incident ticket
data[].raw_subject	string	Original unprocessed subject line before any system modifications
data[].recipient	string	Email address or identifier of the ticket recipient
data[].requester_id	integer	Unique identifier of the user who requested or created the ticket
data[].satisfaction_rating	`object	string`
data[].sharing_agreement_ids	array	Array of sharing agreement identifiers if the ticket is shared across Zendesk instances
data[].status	string	Current status of the ticket (e.g., new, open, pending, solved, closed)
data[].subject	string	Subject line of the ticket describing the issue or request
data[].submitter_id	integer	Unique identifier of the user who submitted the ticket on behalf of the requester
data[].tags	array	Array of tags applied to the ticket for categorization and filtering
data[].ticket_form_id	integer	Unique identifier of the ticket form used when creating the ticket
data[].type	string	Type of ticket (e.g., problem, incident, question, task)
data[].updated_at	string	Timestamp indicating when the ticket was last updated with a ticket event
data[].url	string	API URL to access the full ticket resource
data[].result_type	string	The type of the search result (e.g. ticket) when returned from search endpoints
data[].via	object	Object describing the channel and method through which the ticket was created

Tickets Context Store SQL Query

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

Python SDK

await zendesk_support.tickets.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": "tickets",
    "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

Ticket Comments

Ticket Comments Create

Adds a public reply or internal note to an existing ticket by updating it with a comment object.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "ticket_comments",
  "action": "create",
  "params": {
    "ticket": {
      "comment": {
        "body": "<str>"
      }
    },
    "ticket_id": 0
  }
}'

Python SDK

await zendesk_support.ticket_comments.create(
    ticket={
        "comment": {
            "body": "<str>"
        }
    },
    ticket_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": "ticket_comments",
    "action": "create",
    "params": {
        "ticket": {
            "comment": {
                "body": "<str>"
            }
        },
        "ticket_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
ticket	object	Yes	The ticket update containing the comment
ticket.comment	object	Yes	The comment to add to the ticket
ticket.comment.body	string	Yes	The body of the comment
ticket.comment.html_body	string	No	The HTML body of the comment
ticket.comment.public	boolean	No	Whether the comment is public (true) or an internal note (false). Defaults to true.
ticket.comment.author_id	integer	No	The author of the comment
ticket_id	integer	Yes	The ID of the ticket to comment on

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
external_id	string | null
type	string | null
subject	string | null
raw_subject	string | null
description	string
priority	string | null
status	"new" | "open" | "pending" | "hold" | "solved" | "closed"
recipient	string | null
requester_id	integer
submitter_id	integer
assignee_id	integer | null
organization_id	integer | null
group_id	integer | null
collaborator_ids	array<integer>
follower_ids	array<integer>
email_cc_ids	array<integer>
forum_topic_id	integer | null
problem_id	integer | null
has_incidents	boolean
is_public	boolean
due_at	string | null
tags	array<string>
custom_fields	array<object>
satisfaction_rating	object
sharing_agreement_ids	array<integer>
custom_status_id	integer
fields	array<object>
followup_ids	array<integer>
ticket_form_id	integer
brand_id	integer
allow_channelback	boolean
allow_attachments	boolean
from_messaging_channel	boolean
generated_timestamp	integer
result_type	string | null
created_at	string
updated_at	string
via	object

Ticket Comments List

Returns a list of comments for a specific ticket

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "ticket_comments",
  "action": "list",
  "params": {
    "ticket_id": 0
  }
}'

Python SDK

await zendesk_support.ticket_comments.list(
    ticket_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": "ticket_comments",
    "action": "list",
    "params": {
        "ticket_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
ticket_id	integer	Yes	The ID of the ticket
page	integer	No	Page number for pagination
include_inline_images	boolean	No	Include inline images in the response
sort_order	"asc" | "desc"	No	Sort order for comments (always sorted by created_at)
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
type	string
body	string
html_body	string
plain_body	string
public	boolean
author_id	integer
attachments	array<object>
audit_id	integer
via	object
metadata	object
created_at	string

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Ticket Comments Context Store Search

Search and filter ticket comments 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": "zendesk-support",
  "entity": "ticket_comments",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "attachments": []
        }
      }
    }
  }
}'

Python SDK

await zendesk_support.ticket_comments.context_store_search(
    query={"filter": {"eq": {"attachments": []}}}
)

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

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
attachments	array	List of files or media attached to the comment
audit_id	integer	Identifier of the audit record associated with this comment event
author_id	integer	Identifier of the user who created the comment
body	string	Content of the comment in its original format
created_at	string	Timestamp when the comment was created
event_type	string	Specific classification of the event within the ticket event stream
html_body	string	HTML-formatted content of the comment
id	integer	Unique identifier for the comment event
metadata	object	Additional structured information about the comment not covered by standard fields
plain_body	string	Plain text content of the comment without formatting
public	boolean	Boolean indicating whether the comment is visible to end users or is an internal note
ticket_id	integer	Identifier of the ticket to which this comment belongs
timestamp	integer	Timestamp of when the event occurred in the incremental export stream
type	string	Type of event, typically indicating this is a comment event
uploads	array	Array of upload tokens or identifiers for files being attached to the comment
via	object	Channel or method through which the comment was submitted
via_reference_id	integer	Reference identifier for the channel through which the comment was created

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[].attachments	array	List of files or media attached to the comment
data[].audit_id	integer	Identifier of the audit record associated with this comment event
data[].author_id	integer	Identifier of the user who created the comment
data[].body	string	Content of the comment in its original format
data[].created_at	string	Timestamp when the comment was created
data[].event_type	string	Specific classification of the event within the ticket event stream
data[].html_body	string	HTML-formatted content of the comment
data[].id	integer	Unique identifier for the comment event
data[].metadata	object	Additional structured information about the comment not covered by standard fields
data[].plain_body	string	Plain text content of the comment without formatting
data[].public	boolean	Boolean indicating whether the comment is visible to end users or is an internal note
data[].ticket_id	integer	Identifier of the ticket to which this comment belongs
data[].timestamp	integer	Timestamp of when the event occurred in the incremental export stream
data[].type	string	Type of event, typically indicating this is a comment event
data[].uploads	array	Array of upload tokens or identifiers for files being attached to the comment
data[].via	object	Channel or method through which the comment was submitted
data[].via_reference_id	integer	Reference identifier for the channel through which the comment was created

Ticket Comments Context Store SQL Query

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

Python SDK

await zendesk_support.ticket_comments.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": "ticket_comments",
    "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

Ticket Comments Semantic Search

Search ticket comments 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": "zendesk-support",
  "entity": "ticket_comments",
  "action": "context_store_search",
  "params": {
    "semantic": {"field": "plain_body", "prompt": "<your natural-language query>"}
  }
}'

Python SDK

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

await zendesk_support.execute(
    "ticket_comments",
    "context_store_search",
    {"semantic": {"field": "plain_body", "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": "ticket_comments",
    "action": "context_store_search",
    "params": {
        "semantic": {"field": "plain_body", "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
plain_body	2048	Plain text content of the comment without formatting

Each result is also enriched with the following related fields (returned only; not filterable): authorName, authorRole, ticketTitle, ticketStatus, ticketPriority, ticketRequesterId, ticketAssigneeId, ticketOrganizationId, ticketCreatedAt, ticketUpdatedAt, ticketUrl, ticketTags.

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.created_at	string	Source record field
data[].entity.ticket_id	string	Source record field
data[].entity.author_id	string	Source record field
data[].entity.public	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.authorName	string	Enriched from a related entity at read time (returned only; not filterable)
data[].metadata.authorRole	string	Enriched from a related entity at read time (returned only; not filterable)
data[].metadata.ticketTitle	string	Enriched from a related entity at read time (returned only; not filterable)
data[].metadata.ticketStatus	string	Enriched from a related entity at read time (returned only; not filterable)
data[].metadata.ticketPriority	string	Enriched from a related entity at read time (returned only; not filterable)
data[].metadata.ticketRequesterId	string	Enriched from a related entity at read time (returned only; not filterable)
data[].metadata.ticketAssigneeId	string	Enriched from a related entity at read time (returned only; not filterable)
data[].metadata.ticketOrganizationId	string	Enriched from a related entity at read time (returned only; not filterable)
data[].metadata.ticketCreatedAt	string	Enriched from a related entity at read time (returned only; not filterable)
data[].metadata.ticketUpdatedAt	string	Enriched from a related entity at read time (returned only; not filterable)
data[].metadata.ticketUrl	string	Enriched from a related entity at read time (returned only; not filterable)
data[].metadata.ticketTags	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

Ticket Bulk Updates

Ticket Bulk Updates Create

Updates multiple tickets at once. Accepts a comma-separated list of ticket IDs and applies the same changes to all of them.

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "ticket_bulk_updates",
  "action": "create",
  "params": {
    "ticket": {},
    "ids": "<str>"
  }
}'

Python SDK

await zendesk_support.ticket_bulk_updates.create(
    ticket={},
    ids="<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": "ticket_bulk_updates",
    "action": "create",
    "params": {
        "ticket": {},
        "ids": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
ticket	object	Yes	The ticket fields to apply to all specified tickets
ticket.status	"new" | "open" | "pending" | "hold" | "solved"	No	The state to set on all tickets
ticket.priority	"urgent" | "high" | "normal" | "low"	No	The priority to set on all tickets
ticket.assignee_id	integer	No	The agent to assign all tickets to
ticket.group_id	integer	No	The group to assign all tickets to
ticket.tags	array<string>	No	Tags for the tickets (replaces existing tags)
ticket.additional_tags	array<string>	No	Tags to add to existing tags on the tickets
ticket.remove_tags	array<string>	No	Tags to remove from the tickets
ids	string	Yes	Comma-separated list of ticket IDs to update

Response Schema

Records

Field Name	Type	Description
id	string
url	string
total	integer | null
progress	integer | null
status	string
message	string | null

Deleted Tickets

Deleted Tickets List

Returns a list of deleted tickets in your account. Only tickets deleted in the past 30 days are returned.

CLI

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

Python SDK

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

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number for pagination
sort_by	"id" | "subject" | "deleted_at"	No	Sort tickets by field
sort_order	"asc" | "desc"	No	Sort order
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
subject	string | null
description	string | null
deleted_at	string | null
previous_state	string | null
actor	object | null

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Deleted Tickets Context Store Search

Search and filter deleted tickets 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": "zendesk-support",
  "entity": "deleted_tickets",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "id": 0
        }
      }
    }
  }
}'

Python SDK

await zendesk_support.deleted_tickets.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": "deleted_tickets",
    "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	The unique identifier of the deleted ticket
subject	string	The subject or title of the deleted ticket
description	string	Additional details or comments about the deleted ticket
deleted_at	string	The timestamp when the ticket was deleted
previous_state	string	The state of the ticket before it was deleted
actor	object	The user who performed the deletion 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[].id	integer	The unique identifier of the deleted ticket
data[].subject	string	The subject or title of the deleted ticket
data[].description	string	Additional details or comments about the deleted ticket
data[].deleted_at	string	The timestamp when the ticket was deleted
data[].previous_state	string	The state of the ticket before it was deleted
data[].actor	object	The user who performed the deletion action

Deleted Tickets Context Store SQL Query

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

Python SDK

await zendesk_support.deleted_tickets.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": "deleted_tickets",
    "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

Users

Users List

Returns a list of all users in your account

CLI

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

Python SDK

await zendesk_support.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
role	"end-user" | "agent" | "admin"	No	Filter by role
external_id	string	No	Filter by external id
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
name	string
email	string | null
alias	string | null
phone	string | null
time_zone	string
locale	string
locale_id	integer
organization_id	integer | null
role	"end-user" | "agent" | "admin"
role_type	integer | null
custom_role_id	integer | null
external_id	string | null
tags	array<string>
active	boolean
verified	boolean
shared	boolean
shared_agent	boolean
shared_phone_number	boolean | null
signature	string | null
details	string | null
notes	string | null
suspended	boolean
restricted_agent	boolean
only_private_comments	boolean
moderator	boolean
ticket_restriction	string | null
default_group_id	integer | null
report_csv	boolean
photo	object | null
user_fields	object
last_login_at	string | null
two_factor_auth_enabled	boolean | null
iana_time_zone	string
permanently_deleted	boolean
created_at	string
updated_at	string

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Users Create

Creates a new end-user, agent, or admin in Zendesk Support

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "users",
  "action": "create",
  "params": {
    "user": {
      "name": "<str>"
    }
  }
}'

Python SDK

await zendesk_support.users.create(
    user={
        "name": "<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": "create",
    "params": {
        "user": {
            "name": "<str>"
        }
    }
}'

Parameters

Parameter Name	Type	Required	Description
user	object	Yes	The user object to create
user.name	string	Yes	The user's name
user.email	string	No	The user's primary email address
user.role	"end-user" | "agent" | "admin"	No	The user's role
user.phone	string	No	The user's primary phone number
user.organization_id	integer	No	The id of the user's organization
user.external_id	string	No	A unique identifier from another system
user.alias	string	No	An alias displayed to end users
user.notes	string	No	Notes about the user visible only to agents
user.details	string	No	Any details about the user
user.tags	array<string>	No	Tags for the user
user.verified	boolean	No	If the user's primary identity is verified
user.user_fields	object	No	Custom fields for the user

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
name	string
email	string | null
alias	string | null
phone	string | null
time_zone	string
locale	string
locale_id	integer
organization_id	integer | null
role	"end-user" | "agent" | "admin"
role_type	integer | null
custom_role_id	integer | null
external_id	string | null
tags	array<string>
active	boolean
verified	boolean
shared	boolean
shared_agent	boolean
shared_phone_number	boolean | null
signature	string | null
details	string | null
notes	string | null
suspended	boolean
restricted_agent	boolean
only_private_comments	boolean
moderator	boolean
ticket_restriction	string | null
default_group_id	integer | null
report_csv	boolean
photo	object | null
user_fields	object
last_login_at	string | null
two_factor_auth_enabled	boolean | null
iana_time_zone	string
permanently_deleted	boolean
created_at	string
updated_at	string

Users Get

Returns a user by their ID

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "users",
  "action": "get",
  "params": {
    "user_id": 0
  }
}'

Python SDK

await zendesk_support.users.get(
    user_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": "users",
    "action": "get",
    "params": {
        "user_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
user_id	integer	Yes	The ID of the user

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
name	string
email	string | null
alias	string | null
phone	string | null
time_zone	string
locale	string
locale_id	integer
organization_id	integer | null
role	"end-user" | "agent" | "admin"
role_type	integer | null
custom_role_id	integer | null
external_id	string | null
tags	array<string>
active	boolean
verified	boolean
shared	boolean
shared_agent	boolean
shared_phone_number	boolean | null
signature	string | null
details	string | null
notes	string | null
suspended	boolean
restricted_agent	boolean
only_private_comments	boolean
moderator	boolean
ticket_restriction	string | null
default_group_id	integer | null
report_csv	boolean
photo	object | null
user_fields	object
last_login_at	string | null
two_factor_auth_enabled	boolean | null
iana_time_zone	string
permanently_deleted	boolean
created_at	string
updated_at	string

Users Update

Updates an existing user in Zendesk Support

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "users",
  "action": "update",
  "params": {
    "user": {},
    "user_id": 0
  }
}'

Python SDK

await zendesk_support.users.update(
    user={},
    user_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": "users",
    "action": "update",
    "params": {
        "user": {},
        "user_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
user	object	Yes	The user fields to update
user.name	string	No	The user's name
user.email	string	No	The user's primary email address
user.role	"end-user" | "agent" | "admin"	No	The user's role
user.phone	string	No	The user's primary phone number
user.organization_id	integer	No	The id of the user's organization
user.external_id	string	No	A unique identifier from another system
user.alias	string	No	An alias displayed to end users
user.notes	string	No	Notes about the user visible only to agents
user.details	string	No	Any details about the user
user.tags	array<string>	No	Tags for the user
user.suspended	boolean	No	If the agent is suspended
user.user_fields	object	No	Custom fields for the user
user_id	integer	Yes	The ID of the user to update

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
name	string
email	string | null
alias	string | null
phone	string | null
time_zone	string
locale	string
locale_id	integer
organization_id	integer | null
role	"end-user" | "agent" | "admin"
role_type	integer | null
custom_role_id	integer | null
external_id	string | null
tags	array<string>
active	boolean
verified	boolean
shared	boolean
shared_agent	boolean
shared_phone_number	boolean | null
signature	string | null
details	string | null
notes	string | null
suspended	boolean
restricted_agent	boolean
only_private_comments	boolean
moderator	boolean
ticket_restriction	string | null
default_group_id	integer | null
report_csv	boolean
photo	object | null
user_fields	object
last_login_at	string | null
two_factor_auth_enabled	boolean | null
iana_time_zone	string
permanently_deleted	boolean
created_at	string
updated_at	string

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": "zendesk-support",
  "entity": "users",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "active": true
        }
      }
    }
  }
}'

Python SDK

await zendesk_support.users.context_store_search(
    query={"filter": {"eq": {"active": True}}}
)

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": {"active": True}}}
    }
}'

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
active	boolean	Indicates if the user account is currently active
alias	string	Alternative name or nickname for the user
chat_only	boolean	Indicates if the user can only interact via chat
created_at	string	Timestamp indicating when the user was created
custom_role_id	integer	Identifier for a custom role assigned to the user
default_group_id	integer	Identifier of the default group assigned to the user
details	string	Additional descriptive information about the user
email	string	Email address of the user
external_id	string	External system identifier for the user, used for integrations
iana_time_zone	string	IANA standard time zone identifier for the user
id	integer	Unique identifier for the user
last_login_at	string	Timestamp of the user's most recent login
locale	string	Locale setting determining language and regional format preferences
locale_id	integer	Identifier for the user's locale preference
moderator	boolean	Indicates if the user has moderator privileges
name	string	Display name of the user
notes	string	Internal notes about the user, visible only to agents
only_private_comments	boolean	Indicates if the user can only make private comments on tickets
organization_id	integer	Identifier of the organization the user belongs to
permanently_deleted	boolean	Indicates if the user has been permanently deleted from the system
phone	string	Phone number of the user
photo	object	Profile photo or avatar of the user
report_csv	boolean	Indicates if the user receives reports in CSV format
restricted_agent	boolean	Indicates if the agent has restricted access permissions
role	string	Role assigned to the user defining their permissions level
role_type	integer	Type classification of the user's role
shared	boolean	Indicates if the user is shared across multiple accounts
shared_agent	boolean	Indicates if the user is a shared agent across multiple brands or accounts
shared_phone_number	boolean	Indicates if the phone number is shared with other users
signature	string	Email signature text for the user
suspended	boolean	Indicates if the user account is suspended
tags	array	Labels or tags associated with the user for categorization
ticket_restriction	string	Defines which tickets the user can access based on restrictions
time_zone	string	Time zone setting for the user
two_factor_auth_enabled	boolean	Indicates if two-factor authentication is enabled for the user
updated_at	string	Timestamp indicating when the user was last updated
url	string	API endpoint URL for accessing the user's detailed information
user_fields	object	Custom field values specific to the user, stored as key-value pairs
verified	boolean	Indicates if the user's identity has been verified

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[].active	boolean	Indicates if the user account is currently active
data[].alias	string	Alternative name or nickname for the user
data[].chat_only	boolean	Indicates if the user can only interact via chat
data[].created_at	string	Timestamp indicating when the user was created
data[].custom_role_id	integer	Identifier for a custom role assigned to the user
data[].default_group_id	integer	Identifier of the default group assigned to the user
data[].details	string	Additional descriptive information about the user
data[].email	string	Email address of the user
data[].external_id	string	External system identifier for the user, used for integrations
data[].iana_time_zone	string	IANA standard time zone identifier for the user
data[].id	integer	Unique identifier for the user
data[].last_login_at	string	Timestamp of the user's most recent login
data[].locale	string	Locale setting determining language and regional format preferences
data[].locale_id	integer	Identifier for the user's locale preference
data[].moderator	boolean	Indicates if the user has moderator privileges
data[].name	string	Display name of the user
data[].notes	string	Internal notes about the user, visible only to agents
data[].only_private_comments	boolean	Indicates if the user can only make private comments on tickets
data[].organization_id	integer	Identifier of the organization the user belongs to
data[].permanently_deleted	boolean	Indicates if the user has been permanently deleted from the system
data[].phone	string	Phone number of the user
data[].photo	object	Profile photo or avatar of the user
data[].report_csv	boolean	Indicates if the user receives reports in CSV format
data[].restricted_agent	boolean	Indicates if the agent has restricted access permissions
data[].role	string	Role assigned to the user defining their permissions level
data[].role_type	integer	Type classification of the user's role
data[].shared	boolean	Indicates if the user is shared across multiple accounts
data[].shared_agent	boolean	Indicates if the user is a shared agent across multiple brands or accounts
data[].shared_phone_number	boolean	Indicates if the phone number is shared with other users
data[].signature	string	Email signature text for the user
data[].suspended	boolean	Indicates if the user account is suspended
data[].tags	array	Labels or tags associated with the user for categorization
data[].ticket_restriction	string	Defines which tickets the user can access based on restrictions
data[].time_zone	string	Time zone setting for the user
data[].two_factor_auth_enabled	boolean	Indicates if two-factor authentication is enabled for the user
data[].updated_at	string	Timestamp indicating when the user was last updated
data[].url	string	API endpoint URL for accessing the user's detailed information
data[].user_fields	object	Custom field values specific to the user, stored as key-value pairs
data[].verified	boolean	Indicates if the user's identity has been verified

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

Python SDK

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

Organizations

Organizations List

Returns a list of all organizations in your account

CLI

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

Python SDK

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

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number for pagination
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
name	string
details	string | null
notes	string | null
group_id	integer | null
shared_tickets	boolean
shared_comments	boolean
external_id	string | null
domain_names	array<string>
tags	array<string>
organization_fields	object
created_at	string
updated_at	string

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Organizations Get

Returns an organization by its ID

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "organizations",
  "action": "get",
  "params": {
    "organization_id": 0
  }
}'

Python SDK

await zendesk_support.organizations.get(
    organization_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": "organizations",
    "action": "get",
    "params": {
        "organization_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
organization_id	integer	Yes	The ID of the organization

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
name	string
details	string | null
notes	string | null
group_id	integer | null
shared_tickets	boolean
shared_comments	boolean
external_id	string | null
domain_names	array<string>
tags	array<string>
organization_fields	object
created_at	string
updated_at	string

Organizations Context Store Search

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

Python SDK

await zendesk_support.organizations.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": "organizations",
    "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 organization was created
deleted_at	string	Timestamp when the organization was deleted
details	string	Details about the organization, such as the address
domain_names	array	Array of domain names associated with this organization for automatic user assignment
external_id	string	Unique external identifier to associate the organization to an external record (case-insensitive)
group_id	integer	ID of the group where new tickets from users in this organization are automatically assigned
id	integer	Unique identifier automatically assigned when the organization is created
name	string	Unique name for the organization (mandatory field)
notes	string	Notes about the organization
organization_fields	object	Key-value object for custom organization fields
shared_comments	boolean	Boolean indicating whether end users in this organization can comment on each other's tickets
shared_tickets	boolean	Boolean indicating whether end users in this organization can see each other's tickets
tags	array	Array of tags associated with the organization
updated_at	string	Timestamp of the last update to the organization
url	string	The API URL of this organization

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 organization was created
data[].deleted_at	string	Timestamp when the organization was deleted
data[].details	string	Details about the organization, such as the address
data[].domain_names	array	Array of domain names associated with this organization for automatic user assignment
data[].external_id	string	Unique external identifier to associate the organization to an external record (case-insensitive)
data[].group_id	integer	ID of the group where new tickets from users in this organization are automatically assigned
data[].id	integer	Unique identifier automatically assigned when the organization is created
data[].name	string	Unique name for the organization (mandatory field)
data[].notes	string	Notes about the organization
data[].organization_fields	object	Key-value object for custom organization fields
data[].shared_comments	boolean	Boolean indicating whether end users in this organization can comment on each other's tickets
data[].shared_tickets	boolean	Boolean indicating whether end users in this organization can see each other's tickets
data[].tags	array	Array of tags associated with the organization
data[].updated_at	string	Timestamp of the last update to the organization
data[].url	string	The API URL of this organization

Organizations Context Store SQL Query

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

Python SDK

await zendesk_support.organizations.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": "organizations",
    "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

Groups

Groups List

Returns a list of all groups in your account

CLI

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

Python SDK

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

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number for pagination
exclude_deleted	boolean	No	Exclude deleted groups
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
name	string
description	string
default	boolean
deleted	boolean
is_public	boolean
created_at	string
updated_at	string

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Groups Get

Returns a group by its ID

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "groups",
  "action": "get",
  "params": {
    "group_id": 0
  }
}'

Python SDK

await zendesk_support.groups.get(
    group_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": "groups",
    "action": "get",
    "params": {
        "group_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
group_id	integer	Yes	The ID of the group

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
name	string
description	string
default	boolean
deleted	boolean
is_public	boolean
created_at	string
updated_at	string

Groups Context Store Search

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

Python SDK

await zendesk_support.groups.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": "groups",
    "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 indicating when the group was created
default	boolean	Indicates if the group is the default one for the account
deleted	boolean	Indicates whether the group has been deleted
description	string	The description of the group
id	integer	Unique identifier automatically assigned when creating groups
is_public	boolean	Indicates if the group is public (true) or private (false)
name	string	The name of the group
updated_at	string	Timestamp indicating when the group was last updated
url	string	The API URL of the group

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 indicating when the group was created
data[].default	boolean	Indicates if the group is the default one for the account
data[].deleted	boolean	Indicates whether the group has been deleted
data[].description	string	The description of the group
data[].id	integer	Unique identifier automatically assigned when creating groups
data[].is_public	boolean	Indicates if the group is public (true) or private (false)
data[].name	string	The name of the group
data[].updated_at	string	Timestamp indicating when the group was last updated
data[].url	string	The API URL of the group

Groups Context Store SQL Query

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

Python SDK

await zendesk_support.groups.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": "groups",
    "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

Attachments

Attachments Get

Returns an attachment by its ID

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "attachments",
  "action": "get",
  "params": {
    "attachment_id": 0
  }
}'

Python SDK

await zendesk_support.attachments.get(
    attachment_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": "attachments",
    "action": "get",
    "params": {
        "attachment_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
attachment_id	integer	Yes	The ID of the attachment

Response Schema

Records

Field Name	Type	Description
id	integer
file_name	string
content_url	string
mapped_content_url	string
content_type	string
size	integer
width	integer | null
height	integer | null
inline	boolean
deleted	boolean
malware_access_override	boolean
malware_scan_result	string
url	string
thumbnails	array<object>

Attachments Download

Downloads the file content of a ticket attachment

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "attachments",
  "action": "download",
  "params": {
    "attachment_id": 0
  }
}'

Python SDK

async for chunk in zendesk_support.attachments.download(    attachment_id=0):# Process each chunk (e.g., write to file)
    file.write(chunk)

Note: Download operations return an async iterator of bytes chunks for memory-efficient streaming. Use async for to process chunks as they arrive.

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": "attachments",
    "action": "download",
    "params": {
        "attachment_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
attachment_id	integer	Yes	The ID of the attachment
range_header	string	No	Optional Range header for partial downloads (e.g., 'bytes=0-99')

Ticket Audits

Ticket Audits List

Returns a list of all ticket audits

CLI

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

Python SDK

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

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number for pagination
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
ticket_id	integer
author_id	integer
metadata	object
via	object
events	array<object>
created_at	string

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Ticket Audits List

Returns a list of audits for a specific ticket

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "ticket_audits",
  "action": "list",
  "params": {
    "ticket_id": 0
  }
}'

Python SDK

await zendesk_support.ticket_audits.list(
    ticket_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": "ticket_audits",
    "action": "list",
    "params": {
        "ticket_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
ticket_id	integer	Yes	The ID of the ticket
page	integer	No	Page number for pagination
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
ticket_id	integer
author_id	integer
metadata	object
via	object
events	array<object>
created_at	string

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Ticket Audits Context Store Search

Search and filter ticket audits 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": "zendesk-support",
  "entity": "ticket_audits",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "attachments": []
        }
      }
    }
  }
}'

Python SDK

await zendesk_support.ticket_audits.context_store_search(
    query={"filter": {"eq": {"attachments": []}}}
)

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

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
attachments	array	Files or documents attached to the audit
author_id	integer	The unique identifier of the user who created the audit
created_at	string	Timestamp indicating when the audit was created
events	array	Array of events that occurred in this audit, such as field changes, comments, or tag updates
id	integer	Unique identifier for the audit record, automatically assigned when the audit is created
metadata	object	Custom and system data associated with the audit
ticket_id	integer	The unique identifier of the ticket associated with this audit
via	object	Describes how the audit was created, providing context about the creation source

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[].attachments	array	Files or documents attached to the audit
data[].author_id	integer	The unique identifier of the user who created the audit
data[].created_at	string	Timestamp indicating when the audit was created
data[].events	array	Array of events that occurred in this audit, such as field changes, comments, or tag updates
data[].id	integer	Unique identifier for the audit record, automatically assigned when the audit is created
data[].metadata	object	Custom and system data associated with the audit
data[].ticket_id	integer	The unique identifier of the ticket associated with this audit
data[].via	object	Describes how the audit was created, providing context about the creation source

Ticket Audits Context Store SQL Query

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

Python SDK

await zendesk_support.ticket_audits.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": "ticket_audits",
    "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

Ticket Metrics

Ticket Metrics List

Returns a list of all ticket metrics

CLI

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

Python SDK

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

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number for pagination
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
ticket_id	integer
group_stations	integer
assignee_stations	integer
reopens	integer
replies	integer
assignee_updated_at	string | null
requester_updated_at	string
status_updated_at	string
initially_assigned_at	string | null
assigned_at	string | null
solved_at	string | null
latest_comment_added_at	string
reply_time_in_minutes	object
first_resolution_time_in_minutes	object
full_resolution_time_in_minutes	object
agent_wait_time_in_minutes	object
requester_wait_time_in_minutes	object
on_hold_time_in_minutes	object
created_at	string
updated_at	string

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Ticket Metrics Context Store Search

Search and filter ticket metrics 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": "zendesk-support",
  "entity": "ticket_metrics",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "agent_wait_time_in_minutes": {}
        }
      }
    }
  }
}'

Python SDK

await zendesk_support.ticket_metrics.context_store_search(
    query={"filter": {"eq": {"agent_wait_time_in_minutes": {}}}}
)

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

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
agent_wait_time_in_minutes	object	Number of minutes the agent spent waiting during calendar and business hours
assigned_at	string	Timestamp when the ticket was assigned
assignee_stations	integer	Number of assignees the ticket had
assignee_updated_at	string	Timestamp when the assignee last updated the ticket
created_at	string	Timestamp when the metric record was created
custom_status_updated_at	string	Timestamp when the ticket's custom status was last updated
first_resolution_time_in_minutes	object	Number of minutes to the first resolution time during calendar and business hours
full_resolution_time_in_minutes	object	Number of minutes to the full resolution during calendar and business hours
generated_timestamp	integer	Timestamp of when record was last updated
group_stations	integer	Number of groups the ticket passed through
id	integer	Unique identifier for the ticket metric record
initially_assigned_at	string	Timestamp when the ticket was initially assigned
instance_id	integer	ID of the Zendesk instance associated with the ticket
latest_comment_added_at	string	Timestamp when the latest comment was added
metric	string	Ticket metrics data
on_hold_time_in_minutes	object	Number of minutes on hold
reopens	integer	Total number of times the ticket was reopened
replies	integer	The number of public replies added to a ticket by an agent
reply_time_in_minutes	object	Number of minutes to the first reply during calendar and business hours
reply_time_in_seconds	object	Number of seconds to the first reply during calendar hours, only available for Messaging tickets
requester_updated_at	string	Timestamp when the requester last updated the ticket
requester_wait_time_in_minutes	object	Number of minutes the requester spent waiting during calendar and business hours
solved_at	string	Timestamp when the ticket was solved
status	object	The current status of the ticket (open, pending, solved, etc.).
status_updated_at	string	Timestamp when the status of the ticket was last updated
ticket_id	integer	Identifier of the associated ticket
time	string	Time related to the ticket
type	string	Type of ticket
updated_at	string	Timestamp when the metric record was last updated
url	string	The API url of the ticket metric

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[].agent_wait_time_in_minutes	object	Number of minutes the agent spent waiting during calendar and business hours
data[].assigned_at	string	Timestamp when the ticket was assigned
data[].assignee_stations	integer	Number of assignees the ticket had
data[].assignee_updated_at	string	Timestamp when the assignee last updated the ticket
data[].created_at	string	Timestamp when the metric record was created
data[].custom_status_updated_at	string	Timestamp when the ticket's custom status was last updated
data[].first_resolution_time_in_minutes	object	Number of minutes to the first resolution time during calendar and business hours
data[].full_resolution_time_in_minutes	object	Number of minutes to the full resolution during calendar and business hours
data[].generated_timestamp	integer	Timestamp of when record was last updated
data[].group_stations	integer	Number of groups the ticket passed through
data[].id	integer	Unique identifier for the ticket metric record
data[].initially_assigned_at	string	Timestamp when the ticket was initially assigned
data[].instance_id	integer	ID of the Zendesk instance associated with the ticket
data[].latest_comment_added_at	string	Timestamp when the latest comment was added
data[].metric	string	Ticket metrics data
data[].on_hold_time_in_minutes	object	Number of minutes on hold
data[].reopens	integer	Total number of times the ticket was reopened
data[].replies	integer	The number of public replies added to a ticket by an agent
data[].reply_time_in_minutes	object	Number of minutes to the first reply during calendar and business hours
data[].reply_time_in_seconds	object	Number of seconds to the first reply during calendar hours, only available for Messaging tickets
data[].requester_updated_at	string	Timestamp when the requester last updated the ticket
data[].requester_wait_time_in_minutes	object	Number of minutes the requester spent waiting during calendar and business hours
data[].solved_at	string	Timestamp when the ticket was solved
data[].status	object	The current status of the ticket (open, pending, solved, etc.).
data[].status_updated_at	string	Timestamp when the status of the ticket was last updated
data[].ticket_id	integer	Identifier of the associated ticket
data[].time	string	Time related to the ticket
data[].type	string	Type of ticket
data[].updated_at	string	Timestamp when the metric record was last updated
data[].url	string	The API url of the ticket metric

Ticket Metrics Context Store SQL Query

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

Python SDK

await zendesk_support.ticket_metrics.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": "ticket_metrics",
    "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

Ticket Fields

Ticket Fields List

Returns a list of all ticket fields

CLI

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

Python SDK

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

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number for pagination
locale	string	No	Locale for the results
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
type	string
title	string
raw_title	string
description	string
raw_description	string
position	integer
active	boolean
required	boolean
collapsed_for_agents	boolean
regexp_for_validation	string | null
title_in_portal	string
raw_title_in_portal	string
visible_in_portal	boolean
editable_in_portal	boolean
required_in_portal	boolean
tag	string | null
custom_field_options	array<object>
system_field_options	array<object>
sub_type_id	integer
removable	boolean
agent_description	string | null
created_at	string
updated_at	string

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Ticket Fields Get

Returns a ticket field by its ID

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "ticket_fields",
  "action": "get",
  "params": {
    "ticket_field_id": 0
  }
}'

Python SDK

await zendesk_support.ticket_fields.get(
    ticket_field_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": "ticket_fields",
    "action": "get",
    "params": {
        "ticket_field_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
ticket_field_id	integer	Yes	The ID of the ticket field

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
type	string
title	string
raw_title	string
description	string
raw_description	string
position	integer
active	boolean
required	boolean
collapsed_for_agents	boolean
regexp_for_validation	string | null
title_in_portal	string
raw_title_in_portal	string
visible_in_portal	boolean
editable_in_portal	boolean
required_in_portal	boolean
tag	string | null
custom_field_options	array<object>
system_field_options	array<object>
sub_type_id	integer
removable	boolean
agent_description	string | null
created_at	string
updated_at	string

Ticket Fields Context Store Search

Search and filter ticket fields 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": "zendesk-support",
  "entity": "ticket_fields",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "active": true
        }
      }
    }
  }
}'

Python SDK

await zendesk_support.ticket_fields.context_store_search(
    query={"filter": {"eq": {"active": True}}}
)

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

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
active	boolean	Whether this field is currently available for use
agent_description	string	A description of the ticket field that only agents can see
collapsed_for_agents	boolean	If true, the field is shown to agents by default; if false, it is hidden alongside infrequently used fields
created_at	string	Timestamp when the custom ticket field was created
custom_field_options	array	Array of option objects for custom ticket fields of type multiselect or tagger
custom_statuses	array	List of customized ticket statuses, only present for system ticket fields of type custom_status
description	string	Text describing the purpose of the ticket field to users
editable_in_portal	boolean	Whether this field is editable by end users in Help Center
id	integer	Unique identifier for the ticket field, automatically assigned when created
key	string	Internal identifier or reference key for the field
position	integer	The relative position of the ticket field on a ticket, controlling display order
raw_description	string	The dynamic content placeholder if present, or the description value if not
raw_title	string	The dynamic content placeholder if present, or the title value if not
raw_title_in_portal	string	The dynamic content placeholder if present, or the title_in_portal value if not
regexp_for_validation	string	For regexp fields only, the validation pattern for a field value to be deemed valid
removable	boolean	If false, this field is a system field that must be present on all tickets
required	boolean	If true, agents must enter a value in the field to change the ticket status to solved
required_in_portal	boolean	If true, end users must enter a value in the field to create a request
sub_type_id	integer	For system ticket fields of type priority and status, controlling available options
system_field_options	array	Array of options for system ticket fields of type tickettype, priority, or status
tag	string	For checkbox fields only, a tag added to tickets when the checkbox field is selected
title	string	The title of the ticket field displayed to agents
title_in_portal	string	The title of the ticket field displayed to end users in Help Center
type	string	Field type such as text, textarea, checkbox, date, integer, decimal, regexp, multiselect, or tagger
updated_at	string	Timestamp when the custom ticket field was last updated
url	string	The API URL for this ticket field resource
visible_in_portal	boolean	Whether this field is visible to end users in Help Center

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[].active	boolean	Whether this field is currently available for use
data[].agent_description	string	A description of the ticket field that only agents can see
data[].collapsed_for_agents	boolean	If true, the field is shown to agents by default; if false, it is hidden alongside infrequently used fields
data[].created_at	string	Timestamp when the custom ticket field was created
data[].custom_field_options	array	Array of option objects for custom ticket fields of type multiselect or tagger
data[].custom_statuses	array	List of customized ticket statuses, only present for system ticket fields of type custom_status
data[].description	string	Text describing the purpose of the ticket field to users
data[].editable_in_portal	boolean	Whether this field is editable by end users in Help Center
data[].id	integer	Unique identifier for the ticket field, automatically assigned when created
data[].key	string	Internal identifier or reference key for the field
data[].position	integer	The relative position of the ticket field on a ticket, controlling display order
data[].raw_description	string	The dynamic content placeholder if present, or the description value if not
data[].raw_title	string	The dynamic content placeholder if present, or the title value if not
data[].raw_title_in_portal	string	The dynamic content placeholder if present, or the title_in_portal value if not
data[].regexp_for_validation	string	For regexp fields only, the validation pattern for a field value to be deemed valid
data[].removable	boolean	If false, this field is a system field that must be present on all tickets
data[].required	boolean	If true, agents must enter a value in the field to change the ticket status to solved
data[].required_in_portal	boolean	If true, end users must enter a value in the field to create a request
data[].sub_type_id	integer	For system ticket fields of type priority and status, controlling available options
data[].system_field_options	array	Array of options for system ticket fields of type tickettype, priority, or status
data[].tag	string	For checkbox fields only, a tag added to tickets when the checkbox field is selected
data[].title	string	The title of the ticket field displayed to agents
data[].title_in_portal	string	The title of the ticket field displayed to end users in Help Center
data[].type	string	Field type such as text, textarea, checkbox, date, integer, decimal, regexp, multiselect, or tagger
data[].updated_at	string	Timestamp when the custom ticket field was last updated
data[].url	string	The API URL for this ticket field resource
data[].visible_in_portal	boolean	Whether this field is visible to end users in Help Center

Ticket Fields Context Store SQL Query

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

Python SDK

await zendesk_support.ticket_fields.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": "ticket_fields",
    "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

Brands

Brands List

Returns a list of all brands for the account

CLI

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

Python SDK

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

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number for pagination
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
name	string
brand_url	string
subdomain	string
host_mapping	string | null
has_help_center	boolean
help_center_state	string
active	boolean
default	boolean
is_deleted	boolean
logo	object | null
ticket_form_ids	array<integer>
signature_template	string
created_at	string
updated_at	string

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Brands Get

Returns a brand by its ID

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "brands",
  "action": "get",
  "params": {
    "brand_id": 0
  }
}'

Python SDK

await zendesk_support.brands.get(
    brand_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": "brands",
    "action": "get",
    "params": {
        "brand_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
brand_id	integer	Yes	The ID of the brand

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
name	string
brand_url	string
subdomain	string
host_mapping	string | null
has_help_center	boolean
help_center_state	string
active	boolean
default	boolean
is_deleted	boolean
logo	object | null
ticket_form_ids	array<integer>
signature_template	string
created_at	string
updated_at	string

Brands Context Store Search

Search and filter brands 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": "zendesk-support",
  "entity": "brands",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "active": true
        }
      }
    }
  }
}'

Python SDK

await zendesk_support.brands.context_store_search(
    query={"filter": {"eq": {"active": True}}}
)

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

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
active	boolean	Indicates whether the brand is set as active
brand_url	string	The public URL of the brand
created_at	string	Timestamp when the brand was created
default	boolean	Indicates whether the brand is the default brand for tickets generated from non-branded channels
has_help_center	boolean	Indicates whether the brand has a Help Center enabled
help_center_state	string	The state of the Help Center, with allowed values of enabled, disabled, or restricted
host_mapping	string	The host mapping configuration for the brand, visible only to administrators
id	integer	Unique identifier automatically assigned when the brand is created
is_deleted	boolean	Indicates whether the brand has been deleted
logo	string	Brand logo image file represented as an Attachment object
name	string	The name of the brand
signature_template	string	The signature template used for the brand
subdomain	string	The subdomain associated with the brand
ticket_form_ids	array	Array of ticket form IDs that are available for use by this brand
updated_at	string	Timestamp when the brand was last updated
url	string	The API URL for accessing this brand resource

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[].active	boolean	Indicates whether the brand is set as active
data[].brand_url	string	The public URL of the brand
data[].created_at	string	Timestamp when the brand was created
data[].default	boolean	Indicates whether the brand is the default brand for tickets generated from non-branded channels
data[].has_help_center	boolean	Indicates whether the brand has a Help Center enabled
data[].help_center_state	string	The state of the Help Center, with allowed values of enabled, disabled, or restricted
data[].host_mapping	string	The host mapping configuration for the brand, visible only to administrators
data[].id	integer	Unique identifier automatically assigned when the brand is created
data[].is_deleted	boolean	Indicates whether the brand has been deleted
data[].logo	string	Brand logo image file represented as an Attachment object
data[].name	string	The name of the brand
data[].signature_template	string	The signature template used for the brand
data[].subdomain	string	The subdomain associated with the brand
data[].ticket_form_ids	array	Array of ticket form IDs that are available for use by this brand
data[].updated_at	string	Timestamp when the brand was last updated
data[].url	string	The API URL for accessing this brand resource

Brands Context Store SQL Query

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

Python SDK

await zendesk_support.brands.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": "brands",
    "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

Views

Views List

Returns a list of all views for the account

CLI

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

Python SDK

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

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number for pagination
access	"personal" | "shared" | "account"	No	Filter by access level
active	boolean	No	Filter by active status
group_id	integer	No	Filter by group ID
sort_by	"alphabetical" | "created_at" | "updated_at" | "position"	No	Sort results
sort_order	"asc" | "desc"	No	Sort order
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
title	string
active	boolean
position	integer
description	string | null
execution	object
conditions	object
restriction	object | null
raw_title	string
created_at	string
updated_at	string

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Views Get

Returns a view by its ID

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "views",
  "action": "get",
  "params": {
    "view_id": 0
  }
}'

Python SDK

await zendesk_support.views.get(
    view_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": "views",
    "action": "get",
    "params": {
        "view_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
view_id	integer	Yes	The ID of the view

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
title	string
active	boolean
position	integer
description	string | null
execution	object
conditions	object
restriction	object | null
raw_title	string
created_at	string
updated_at	string

Macros

Macros Get

Returns a macro by its ID

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "macros",
  "action": "get",
  "params": {
    "macro_id": 0
  }
}'

Python SDK

await zendesk_support.macros.get(
    macro_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": "macros",
    "action": "get",
    "params": {
        "macro_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
macro_id	integer	Yes	The ID of the macro

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
title	string
active	boolean
position	integer
description	string
actions	array<object>
restriction	object | null
raw_title	string
created_at	string
updated_at	string

Macros List

Returns a list of all macros for the account

CLI

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

Python SDK

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

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number for pagination
access	"personal" | "shared" | "account"	No	Filter by access level
active	boolean	No	Filter by active status
category	integer	No	Filter by category
group_id	integer	No	Filter by group ID
only_viewable	boolean	No	Return only viewable macros
sort_by	"alphabetical" | "created_at" | "updated_at" | "position"	No	Sort results
sort_order	"asc" | "desc"	No	Sort order
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
title	string
active	boolean
position	integer
description	string
actions	array<object>
restriction	object | null
raw_title	string
created_at	string
updated_at	string

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Macros Context Store Search

Search and filter macros 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": "zendesk-support",
  "entity": "macros",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "id": 0
        }
      }
    }
  }
}'

Python SDK

await zendesk_support.macros.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": "macros",
    "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	Automatically assigned when the macro is created
url	string	A URL to access the macro's details
title	string	The title of the macro
active	boolean	Useful for determining if the macro should be displayed
position	integer	The position of the macro
description	string	The description of the macro
actions	array	Actions to perform when macro is applied
restriction	object	Who may access this macro
raw_title	string	The dynamic content placeholder for title
created_at	string	The time the macro was created
updated_at	string	The time the macro was last updated

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	Automatically assigned when the macro is created
data[].url	string	A URL to access the macro's details
data[].title	string	The title of the macro
data[].active	boolean	Useful for determining if the macro should be displayed
data[].position	integer	The position of the macro
data[].description	string	The description of the macro
data[].actions	array	Actions to perform when macro is applied
data[].restriction	object	Who may access this macro
data[].raw_title	string	The dynamic content placeholder for title
data[].created_at	string	The time the macro was created
data[].updated_at	string	The time the macro was last updated

Macros Context Store SQL Query

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

Python SDK

await zendesk_support.macros.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": "macros",
    "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

Triggers

Triggers List

Returns a list of all triggers for the account

CLI

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

Python SDK

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

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number for pagination
active	boolean	No	Filter by active status
category_id	string	No	Filter by category ID
sort_by	"alphabetical" | "created_at" | "updated_at" | "usage_1h" | "usage_24h" | "usage_7d"	No	Sort field for offset pagination
sort_order	"asc" | "desc"	No	Sort order for offset pagination
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
title	string
active	boolean
position	integer
description	string | null
conditions	object
actions	array<object>
raw_title	string
category_id	string
created_at	string
updated_at	string

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Triggers Get

Returns a trigger by its ID

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "triggers",
  "action": "get",
  "params": {
    "trigger_id": 0
  }
}'

Python SDK

await zendesk_support.triggers.get(
    trigger_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": "triggers",
    "action": "get",
    "params": {
        "trigger_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
trigger_id	integer	Yes	The ID of the trigger

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
title	string
active	boolean
position	integer
description	string | null
conditions	object
actions	array<object>
raw_title	string
category_id	string
created_at	string
updated_at	string

Triggers Context Store Search

Search and filter triggers 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": "zendesk-support",
  "entity": "triggers",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "id": 0
        }
      }
    }
  }
}'

Python SDK

await zendesk_support.triggers.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": "triggers",
    "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	Automatically assigned when created
url	string	The URL of the trigger
title	string	The title of the trigger
active	boolean	Whether the trigger is active
position	integer	Position of the trigger
description	string	The description of the trigger
conditions	object	An object that describes the conditions under which the trigger will execute
actions	array	An array of actions
raw_title	string	The dynamic content placeholder for title
category_id	string	The ID of the category the trigger belongs to
created_at	string	The time the trigger was created
updated_at	string	The time the trigger was last updated

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	Automatically assigned when created
data[].url	string	The URL of the trigger
data[].title	string	The title of the trigger
data[].active	boolean	Whether the trigger is active
data[].position	integer	Position of the trigger
data[].description	string	The description of the trigger
data[].conditions	object	An object that describes the conditions under which the trigger will execute
data[].actions	array	An array of actions
data[].raw_title	string	The dynamic content placeholder for title
data[].category_id	string	The ID of the category the trigger belongs to
data[].created_at	string	The time the trigger was created
data[].updated_at	string	The time the trigger was last updated

Triggers Context Store SQL Query

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

Python SDK

await zendesk_support.triggers.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": "triggers",
    "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

Automations

Automations List

Returns a list of all automations for the account

CLI

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

Python SDK

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

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number for pagination
active	boolean	No	Filter by active status
sort_by	"alphabetical" | "created_at" | "updated_at" | "usage_1h" | "usage_24h" | "usage_7d"	No	Sort field for offset pagination
sort_order	"asc" | "desc"	No	Sort order for offset pagination
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
title	string
active	boolean
position	integer
conditions	object
actions	array<object>
raw_title	string
created_at	string
updated_at	string

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Automations Get

Returns an automation by its ID

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "automations",
  "action": "get",
  "params": {
    "automation_id": 0
  }
}'

Python SDK

await zendesk_support.automations.get(
    automation_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": "automations",
    "action": "get",
    "params": {
        "automation_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
automation_id	integer	Yes	The ID of the automation

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
title	string
active	boolean
position	integer
conditions	object
actions	array<object>
raw_title	string
created_at	string
updated_at	string

Automations Context Store Search

Search and filter automations 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": "zendesk-support",
  "entity": "automations",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "id": 0
        }
      }
    }
  }
}'

Python SDK

await zendesk_support.automations.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": "automations",
    "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	Automatically assigned when created
title	string	The title of the automation
active	boolean	Whether the automation is active
position	integer	The position of the automation
conditions	object	An object that describes the conditions under which the automation will execute
actions	array	An array of actions
raw_title	string	The dynamic content placeholder for title
created_at	string	The time the automation was created
updated_at	string	The time the automation was last updated

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	Automatically assigned when created
data[].title	string	The title of the automation
data[].active	boolean	Whether the automation is active
data[].position	integer	The position of the automation
data[].conditions	object	An object that describes the conditions under which the automation will execute
data[].actions	array	An array of actions
data[].raw_title	string	The dynamic content placeholder for title
data[].created_at	string	The time the automation was created
data[].updated_at	string	The time the automation was last updated

Automations Context Store SQL Query

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

Python SDK

await zendesk_support.automations.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": "automations",
    "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

Tags

Tags List

Returns a list of all tags used in the account

CLI

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

Python SDK

await zendesk_support.tags.list()

API

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

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number for pagination
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
name	string
count	integer

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

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": "zendesk-support",
  "entity": "tags",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "count": 0
        }
      }
    }
  }
}'

Python SDK

await zendesk_support.tags.context_store_search(
    query={"filter": {"eq": {"count": 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": "tags",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"count": 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
count	integer	The number of times this tag has been used across resources
name	string	The tag name string used to label and categorize resources

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[].count	integer	The number of times this tag has been used across resources
data[].name	string	The tag name string used to label and categorize resources

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

Python SDK

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

Satisfaction Ratings

Satisfaction Ratings List

Returns a list of all satisfaction ratings

CLI

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

Python SDK

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

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number for pagination
score	"offered" | "unoffered" | "received" | "good" | "bad"	No	Filter by score
start_time	integer	No	Start time (Unix epoch)
end_time	integer	No	End time (Unix epoch)
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
assignee_id	integer | null
group_id	integer | null
requester_id	integer
ticket_id	integer
score	string
comment	string | null
reason	string | null
reason_id	integer | null
reason_code	integer | null
created_at	string
updated_at	string

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Satisfaction Ratings Get

Returns a satisfaction rating by its ID

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "satisfaction_ratings",
  "action": "get",
  "params": {
    "satisfaction_rating_id": 0
  }
}'

Python SDK

await zendesk_support.satisfaction_ratings.get(
    satisfaction_rating_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": "satisfaction_ratings",
    "action": "get",
    "params": {
        "satisfaction_rating_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
satisfaction_rating_id	integer	Yes	The ID of the satisfaction rating

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
assignee_id	integer | null
group_id	integer | null
requester_id	integer
ticket_id	integer
score	string
comment	string | null
reason	string | null
reason_id	integer | null
reason_code	integer | null
created_at	string
updated_at	string

Satisfaction Ratings Context Store Search

Search and filter satisfaction ratings 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": "zendesk-support",
  "entity": "satisfaction_ratings",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "assignee_id": 0
        }
      }
    }
  }
}'

Python SDK

await zendesk_support.satisfaction_ratings.context_store_search(
    query={"filter": {"eq": {"assignee_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": "satisfaction_ratings",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"assignee_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
assignee_id	integer	The identifier of the agent assigned to the ticket at the time the rating was submitted
comment	string	Optional comment provided by the requester with the rating
created_at	string	Timestamp indicating when the satisfaction rating was created
group_id	integer	The identifier of the group assigned to the ticket at the time the rating was submitted
id	integer	Unique identifier for the satisfaction rating, automatically assigned upon creation
reason	string	Free-text reason for a bad rating provided by the requester in a follow-up question
reason_id	integer	Identifier for the predefined reason given for a negative rating
requester_id	integer	The identifier of the ticket requester who submitted the satisfaction rating
score	string	The satisfaction rating value: 'offered', 'unoffered', 'good', or 'bad'
ticket_id	integer	The identifier of the ticket being rated
updated_at	string	Timestamp indicating when the satisfaction rating was last updated
url	string	The API URL of this satisfaction rating resource

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[].assignee_id	integer	The identifier of the agent assigned to the ticket at the time the rating was submitted
data[].comment	string	Optional comment provided by the requester with the rating
data[].created_at	string	Timestamp indicating when the satisfaction rating was created
data[].group_id	integer	The identifier of the group assigned to the ticket at the time the rating was submitted
data[].id	integer	Unique identifier for the satisfaction rating, automatically assigned upon creation
data[].reason	string	Free-text reason for a bad rating provided by the requester in a follow-up question
data[].reason_id	integer	Identifier for the predefined reason given for a negative rating
data[].requester_id	integer	The identifier of the ticket requester who submitted the satisfaction rating
data[].score	string	The satisfaction rating value: 'offered', 'unoffered', 'good', or 'bad'
data[].ticket_id	integer	The identifier of the ticket being rated
data[].updated_at	string	Timestamp indicating when the satisfaction rating was last updated
data[].url	string	The API URL of this satisfaction rating resource

Satisfaction Ratings Context Store SQL Query

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

Python SDK

await zendesk_support.satisfaction_ratings.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": "satisfaction_ratings",
    "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

Group Memberships

Group Memberships List

Returns a list of all group memberships

CLI

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

Python SDK

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

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number for pagination
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
user_id	integer
group_id	integer
default	boolean
created_at	string
updated_at	string

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Group Memberships Context Store Search

Search and filter group memberships 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": "zendesk-support",
  "entity": "group_memberships",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "id": 0
        }
      }
    }
  }
}'

Python SDK

await zendesk_support.group_memberships.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": "group_memberships",
    "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	Automatically assigned upon creation
url	string	The API url of this record
user_id	integer	The id of an agent
group_id	integer	The id of a group
default	boolean	If true, tickets assigned directly to the agent will assume this membership's group
created_at	string	When the group membership was created
updated_at	string	When the group membership was last updated

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	Automatically assigned upon creation
data[].url	string	The API url of this record
data[].user_id	integer	The id of an agent
data[].group_id	integer	The id of a group
data[].default	boolean	If true, tickets assigned directly to the agent will assume this membership's group
data[].created_at	string	When the group membership was created
data[].updated_at	string	When the group membership was last updated

Group Memberships Context Store SQL Query

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

Python SDK

await zendesk_support.group_memberships.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": "group_memberships",
    "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

Organization Memberships

Organization Memberships List

Returns a list of all organization memberships

CLI

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

Python SDK

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

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number for pagination
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
user_id	integer
organization_id	integer
default	boolean
organization_name	string
view_tickets	boolean
created_at	string
updated_at	string

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Organization Memberships Context Store Search

Search and filter organization memberships 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": "zendesk-support",
  "entity": "organization_memberships",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "id": 0
        }
      }
    }
  }
}'

Python SDK

await zendesk_support.organization_memberships.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": "organization_memberships",
    "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	Automatically assigned when the membership is created
url	string	The API url of this membership
user_id	integer	The ID of the user for whom this memberships belongs
organization_id	integer	The ID of the organization associated with this user
default	boolean	If true, this is the default organization for the user
organization_name	string	The name of the organization
view_tickets	boolean	If true, this user can view tickets from this organization
created_at	string	When the membership was created
updated_at	string	When the membership was last updated

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	Automatically assigned when the membership is created
data[].url	string	The API url of this membership
data[].user_id	integer	The ID of the user for whom this memberships belongs
data[].organization_id	integer	The ID of the organization associated with this user
data[].default	boolean	If true, this is the default organization for the user
data[].organization_name	string	The name of the organization
data[].view_tickets	boolean	If true, this user can view tickets from this organization
data[].created_at	string	When the membership was created
data[].updated_at	string	When the membership was last updated

Organization Memberships Context Store SQL Query

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

Python SDK

await zendesk_support.organization_memberships.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": "organization_memberships",
    "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

Sla Policies

Sla Policies List

Returns a list of all SLA policies

CLI

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

Python SDK

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

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number for pagination
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
title	string
description	string
position	integer
filter	object
policy_metrics	array<object>
created_at	string
updated_at	string

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Sla Policies Get

Returns an SLA policy by its ID

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "sla_policies",
  "action": "get",
  "params": {
    "sla_policy_id": 0
  }
}'

Python SDK

await zendesk_support.sla_policies.get(
    sla_policy_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": "sla_policies",
    "action": "get",
    "params": {
        "sla_policy_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
sla_policy_id	integer	Yes	The ID of the SLA policy

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
title	string
description	string
position	integer
filter	object
policy_metrics	array<object>
created_at	string
updated_at	string

Sla Policies Context Store Search

Search and filter sla policies 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": "zendesk-support",
  "entity": "sla_policies",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "id": 0
        }
      }
    }
  }
}'

Python SDK

await zendesk_support.sla_policies.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": "sla_policies",
    "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	Automatically assigned when the SLA policy is created
url	string	URL of the SLA policy
title	string	The title of the SLA policy
description	string	The description of the SLA policy
position	integer	Position of the SLA policy
filter	object	Filter for the SLA policy
policy_metrics	array	Array of policy metrics
created_at	string	When the SLA policy was created
updated_at	string	When the SLA policy was last updated

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	Automatically assigned when the SLA policy is created
data[].url	string	URL of the SLA policy
data[].title	string	The title of the SLA policy
data[].description	string	The description of the SLA policy
data[].position	integer	Position of the SLA policy
data[].filter	object	Filter for the SLA policy
data[].policy_metrics	array	Array of policy metrics
data[].created_at	string	When the SLA policy was created
data[].updated_at	string	When the SLA policy was last updated

Sla Policies Context Store SQL Query

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

Python SDK

await zendesk_support.sla_policies.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": "sla_policies",
    "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

Ticket Forms

Ticket Forms List

Returns a list of all ticket forms for the account

CLI

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

Python SDK

await zendesk_support.ticket_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": "ticket_forms",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number for pagination
active	boolean	No	Filter by active status
end_user_visible	boolean	No	Filter by end user visibility
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
name	string
display_name	string
raw_name	string
raw_display_name	string
position	integer
active	boolean
end_user_visible	boolean
default	boolean
in_all_brands	boolean
restricted_brand_ids	array<integer>
ticket_field_ids	array<integer>
agent_conditions	array<object>
end_user_conditions	array<object>
created_at	string
updated_at	string

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Ticket Forms Get

Returns a ticket form by its ID

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "ticket_forms",
  "action": "get",
  "params": {
    "ticket_form_id": 0
  }
}'

Python SDK

await zendesk_support.ticket_forms.get(
    ticket_form_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": "ticket_forms",
    "action": "get",
    "params": {
        "ticket_form_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
ticket_form_id	integer	Yes	The ID of the ticket form

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
name	string
display_name	string
raw_name	string
raw_display_name	string
position	integer
active	boolean
end_user_visible	boolean
default	boolean
in_all_brands	boolean
restricted_brand_ids	array<integer>
ticket_field_ids	array<integer>
agent_conditions	array<object>
end_user_conditions	array<object>
created_at	string
updated_at	string

Ticket Forms Context Store Search

Search and filter ticket 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": "zendesk-support",
  "entity": "ticket_forms",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "active": true
        }
      }
    }
  }
}'

Python SDK

await zendesk_support.ticket_forms.context_store_search(
    query={"filter": {"eq": {"active": True}}}
)

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

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
active	boolean	Indicates if the form is set as active
agent_conditions	array	Array of condition sets for agent workspaces
created_at	string	Timestamp when the ticket form was created
default	boolean	Indicates if the form is the default form for this account
display_name	string	The name of the form that is displayed to an end user
end_user_conditions	array	Array of condition sets for end user products
end_user_visible	boolean	Indicates if the form is visible to the end user
id	integer	Unique identifier for the ticket form, automatically assigned when creating the form
in_all_brands	boolean	Indicates if the form is available for use in all brands on this account
name	string	The name of the ticket form
position	integer	The position of this form among other forms in the account, such as in a dropdown
raw_display_name	string	The dynamic content placeholder if present, or the display_name value if not
raw_name	string	The dynamic content placeholder if present, or the name value if not
restricted_brand_ids	array	IDs of all brands that this ticket form is restricted to
ticket_field_ids	array	IDs of all ticket fields included in this ticket form
updated_at	string	Timestamp of the last update to the ticket form
url	string	URL of the ticket form

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[].active	boolean	Indicates if the form is set as active
data[].agent_conditions	array	Array of condition sets for agent workspaces
data[].created_at	string	Timestamp when the ticket form was created
data[].default	boolean	Indicates if the form is the default form for this account
data[].display_name	string	The name of the form that is displayed to an end user
data[].end_user_conditions	array	Array of condition sets for end user products
data[].end_user_visible	boolean	Indicates if the form is visible to the end user
data[].id	integer	Unique identifier for the ticket form, automatically assigned when creating the form
data[].in_all_brands	boolean	Indicates if the form is available for use in all brands on this account
data[].name	string	The name of the ticket form
data[].position	integer	The position of this form among other forms in the account, such as in a dropdown
data[].raw_display_name	string	The dynamic content placeholder if present, or the display_name value if not
data[].raw_name	string	The dynamic content placeholder if present, or the name value if not
data[].restricted_brand_ids	array	IDs of all brands that this ticket form is restricted to
data[].ticket_field_ids	array	IDs of all ticket fields included in this ticket form
data[].updated_at	string	Timestamp of the last update to the ticket form
data[].url	string	URL of the ticket form

Ticket Forms Context Store SQL Query

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

Python SDK

await zendesk_support.ticket_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": "ticket_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

Articles

Articles List

Returns a list of all articles in the Help Center

CLI

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

Python SDK

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

Parameters

Parameter Name	Type	Required	Description
page	integer	No	Page number for pagination
sort_by	"created_at" | "updated_at" | "title" | "position"	No	Sort articles by field
sort_order	"asc" | "desc"	No	Sort order
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
html_url	string
title	string
body	string
locale	string
author_id	integer
section_id	integer
created_at	string
updated_at	string
vote_sum	integer
vote_count	integer
label_names	array<string>
draft	boolean
promoted	boolean
position	integer

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Articles Get

Retrieves the details of a specific article

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "articles",
  "action": "get",
  "params": {
    "id": 0
  }
}'

Python SDK

await zendesk_support.articles.get(
    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": "articles",
    "action": "get",
    "params": {
        "id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
id	integer	Yes	The unique ID of the article

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
html_url	string
title	string
body	string
locale	string
author_id	integer
section_id	integer
created_at	string
updated_at	string
vote_sum	integer
vote_count	integer
label_names	array<string>
draft	boolean
promoted	boolean
position	integer

Articles Context Store Search

Search and filter articles 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": "zendesk-support",
  "entity": "articles",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "id": 0
        }
      }
    }
  }
}'

Python SDK

await zendesk_support.articles.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": "articles",
    "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	The unique ID of the article
url	string	The API URL of the article
html_url	string	The public URL of the article
title	string	The title of the article
body	string	The body content of the article (HTML)
locale	string	The locale of the article
author_id	integer	The ID of the user who created the article
section_id	integer	The ID of the section the article belongs to
created_at	string	The time the article was created
updated_at	string	The time the article was last updated
vote_sum	integer	Sum of upvotes and downvotes
vote_count	integer	Number of votes
label_names	array	List of label names associated with the article
draft	boolean	Whether the article is a draft
promoted	boolean	Whether the article is promoted
position	integer	Position of the article in the section

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	The unique ID of the article
data[].url	string	The API URL of the article
data[].html_url	string	The public URL of the article
data[].title	string	The title of the article
data[].body	string	The body content of the article (HTML)
data[].locale	string	The locale of the article
data[].author_id	integer	The ID of the user who created the article
data[].section_id	integer	The ID of the section the article belongs to
data[].created_at	string	The time the article was created
data[].updated_at	string	The time the article was last updated
data[].vote_sum	integer	Sum of upvotes and downvotes
data[].vote_count	integer	Number of votes
data[].label_names	array	List of label names associated with the article
data[].draft	boolean	Whether the article is a draft
data[].promoted	boolean	Whether the article is promoted
data[].position	integer	Position of the article in the section

Articles Context Store SQL Query

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

Python SDK

await zendesk_support.articles.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": "articles",
    "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

Article Attachments

Article Attachments List

Returns a list of all attachments for a specific article

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "article_attachments",
  "action": "list",
  "params": {
    "article_id": 0
  }
}'

Python SDK

await zendesk_support.article_attachments.list(
    article_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": "article_attachments",
    "action": "list",
    "params": {
        "article_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
article_id	integer	Yes	The unique ID of the article
page	integer	No	Page number for pagination
per_page	integer	No	Number of results per page

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
article_id	integer
file_name	string
content_type	string
content_url	string
size	integer
inline	boolean
created_at	string
updated_at	string

Meta

Field Name	Type	Description
next_page	string | null
previous_page	string | null
count	integer

Article Attachments Get

Retrieves the metadata of a specific attachment for a specific article

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "article_attachments",
  "action": "get",
  "params": {
    "article_id": 0,
    "attachment_id": 0
  }
}'

Python SDK

await zendesk_support.article_attachments.get(
    article_id=0,
    attachment_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": "article_attachments",
    "action": "get",
    "params": {
        "article_id": 0,
        "attachment_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
article_id	integer	Yes	The unique ID of the article
attachment_id	integer	Yes	The unique ID of the attachment

Response Schema

Records

Field Name	Type	Description
id	integer
url	string
article_id	integer
file_name	string
content_type	string
content_url	string
size	integer
inline	boolean
created_at	string
updated_at	string

Article Attachments Download

Downloads the file content of a specific attachment

CLI

airbyte-agent connectors execute --json '{
  "workspace": "<your_workspace_name>",
  "name": "zendesk-support",
  "entity": "article_attachments",
  "action": "download",
  "params": {
    "article_id": 0,
    "attachment_id": 0
  }
}'

Python SDK

async for chunk in zendesk_support.article_attachments.download(    article_id=0,    attachment_id=0):# Process each chunk (e.g., write to file)
    file.write(chunk)

Note: Download operations return an async iterator of bytes chunks for memory-efficient streaming. Use async for to process chunks as they arrive.

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": "article_attachments",
    "action": "download",
    "params": {
        "article_id": 0,
        "attachment_id": 0
    }
}'

Parameters

Parameter Name	Type	Required	Description
article_id	integer	Yes	The unique ID of the article
attachment_id	integer	Yes	The unique ID of the attachment
range_header	string	No	Optional Range header for partial downloads (e.g., 'bytes=0-99')

Article Attachments Context Store Search

Search and filter article attachments 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": "zendesk-support",
  "entity": "article_attachments",
  "action": "context_store_search",
  "params": {
    "query": {
      "filter": {
        "eq": {
          "id": 0
        }
      }
    }
  }
}'

Python SDK

await zendesk_support.article_attachments.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": "article_attachments",
    "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	The unique ID of the attachment
url	string	The API URL of the attachment
article_id	integer	The ID of the article this attachment belongs to
file_name	string	The name of the attached file
content_type	string	The MIME type of the attachment
content_url	string	The URL to download the attachment
size	integer	The size of the attachment in bytes
inline	boolean	Whether the attachment is displayed inline
created_at	string	The time the attachment was created
updated_at	string	The time the attachment was last updated

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	The unique ID of the attachment
data[].url	string	The API URL of the attachment
data[].article_id	integer	The ID of the article this attachment belongs to
data[].file_name	string	The name of the attached file
data[].content_type	string	The MIME type of the attachment
data[].content_url	string	The URL to download the attachment
data[].size	integer	The size of the attachment in bytes
data[].inline	boolean	Whether the attachment is displayed inline
data[].created_at	string	The time the attachment was created
data[].updated_at	string	The time the attachment was last updated

Article Attachments Context Store SQL Query

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

Python SDK

await zendesk_support.article_attachments.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": "article_attachments",
    "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