Skip to main content

Zendesk-Support

Supported Entities and Actions

EntityActions
TicketsList, Get
UsersList, Get
OrganizationsList, Get
GroupsList, Get
Ticket CommentsList
AttachmentsGet, Download
Ticket AuditsList, List
Ticket MetricsList
Ticket FieldsList, Get
BrandsList, Get
ViewsList, Get
MacrosList, Get
TriggersList, Get
AutomationsList, Get
TagsList
Satisfaction RatingsList, Get
Group MembershipsList
Organization MembershipsList
Sla PoliciesList, Get
Ticket FormsList, Get
ArticlesList, Get
Article AttachmentsList, Get, Download

Tickets

Tickets List

Returns a list of all tickets in your account

Python SDK

zendesk_support.tickets.list()

API

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

Params

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
external_idstringNoLists tickets by external id
sort"id" | "status" | "updated_at" | "-id" | "-status" | "-updated_at"NoSort order
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
external_idstring | null
typestring | null
subjectstring | null
raw_subjectstring | null
descriptionstring
prioritystring | null
status"new" | "open" | "pending" | "hold" | "solved" | "closed"
recipientstring | null
requester_idinteger
submitter_idinteger
assignee_idinteger | null
organization_idinteger | null
group_idinteger | null
collaborator_idsarray<integer>
follower_idsarray<integer>
email_cc_idsarray<integer>
forum_topic_idinteger | null
problem_idinteger | null
has_incidentsboolean
is_publicboolean
due_atstring | null
tagsarray<string>
custom_fieldsarray<object>
satisfaction_ratingobject
sharing_agreement_idsarray<integer>
custom_status_idinteger
fieldsarray<object>
followup_idsarray<integer>
ticket_form_idinteger
brand_idinteger
allow_channelbackboolean
allow_attachmentsboolean
from_messaging_channelboolean
generated_timestampinteger
created_atstring
updated_atstring
viaobject

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Tickets Get

Returns a ticket by its ID

Python SDK

zendesk_support.tickets.get(
ticket_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "tickets",
"action": "get",
"params": {
"ticket_id": 0
}
}'

Params

Parameter NameTypeRequiredDescription
ticket_idintegerYesThe ID of the ticket
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
external_idstring | null
typestring | null
subjectstring | null
raw_subjectstring | null
descriptionstring
prioritystring | null
status"new" | "open" | "pending" | "hold" | "solved" | "closed"
recipientstring | null
requester_idinteger
submitter_idinteger
assignee_idinteger | null
organization_idinteger | null
group_idinteger | null
collaborator_idsarray<integer>
follower_idsarray<integer>
email_cc_idsarray<integer>
forum_topic_idinteger | null
problem_idinteger | null
has_incidentsboolean
is_publicboolean
due_atstring | null
tagsarray<string>
custom_fieldsarray<object>
satisfaction_ratingobject
sharing_agreement_idsarray<integer>
custom_status_idinteger
fieldsarray<object>
followup_idsarray<integer>
ticket_form_idinteger
brand_idinteger
allow_channelbackboolean
allow_attachmentsboolean
from_messaging_channelboolean
generated_timestampinteger
created_atstring
updated_atstring
viaobject

Users

Users List

Returns a list of all users in your account

Python SDK

zendesk_support.users.list()

API

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

Params

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
role"end-user" | "agent" | "admin"NoFilter by role
external_idstringNoFilter by external id
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
namestring
emailstring | null
aliasstring | null
phonestring | null
time_zonestring
localestring
locale_idinteger
organization_idinteger | null
role"end-user" | "agent" | "admin"
role_typeinteger | null
custom_role_idinteger | null
external_idstring | null
tagsarray<string>
activeboolean
verifiedboolean
sharedboolean
shared_agentboolean
shared_phone_numberboolean | null
signaturestring | null
detailsstring | null
notesstring | null
suspendedboolean
restricted_agentboolean
only_private_commentsboolean
moderatorboolean
ticket_restrictionstring | null
default_group_idinteger | null
report_csvboolean
photoobject | null
user_fieldsobject
last_login_atstring | null
two_factor_auth_enabledboolean | null
iana_time_zonestring
permanently_deletedboolean
created_atstring
updated_atstring

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Users Get

Returns a user by their ID

Python SDK

zendesk_support.users.get(
user_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "users",
"action": "get",
"params": {
"user_id": 0
}
}'

Params

Parameter NameTypeRequiredDescription
user_idintegerYesThe ID of the user
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
namestring
emailstring | null
aliasstring | null
phonestring | null
time_zonestring
localestring
locale_idinteger
organization_idinteger | null
role"end-user" | "agent" | "admin"
role_typeinteger | null
custom_role_idinteger | null
external_idstring | null
tagsarray<string>
activeboolean
verifiedboolean
sharedboolean
shared_agentboolean
shared_phone_numberboolean | null
signaturestring | null
detailsstring | null
notesstring | null
suspendedboolean
restricted_agentboolean
only_private_commentsboolean
moderatorboolean
ticket_restrictionstring | null
default_group_idinteger | null
report_csvboolean
photoobject | null
user_fieldsobject
last_login_atstring | null
two_factor_auth_enabledboolean | null
iana_time_zonestring
permanently_deletedboolean
created_atstring
updated_atstring

Organizations

Organizations List

Returns a list of all organizations in your account

Python SDK

zendesk_support.organizations.list()

API

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

Params

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
namestring
detailsstring | null
notesstring | null
group_idinteger | null
shared_ticketsboolean
shared_commentsboolean
external_idstring | null
domain_namesarray<string>
tagsarray<string>
organization_fieldsobject
created_atstring
updated_atstring

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Organizations Get

Returns an organization by its ID

Python SDK

zendesk_support.organizations.get(
organization_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "organizations",
"action": "get",
"params": {
"organization_id": 0
}
}'

Params

Parameter NameTypeRequiredDescription
organization_idintegerYesThe ID of the organization
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
namestring
detailsstring | null
notesstring | null
group_idinteger | null
shared_ticketsboolean
shared_commentsboolean
external_idstring | null
domain_namesarray<string>
tagsarray<string>
organization_fieldsobject
created_atstring
updated_atstring

Groups

Groups List

Returns a list of all groups in your account

Python SDK

zendesk_support.groups.list()

API

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

Params

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
exclude_deletedbooleanNoExclude deleted groups
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
namestring
descriptionstring
defaultboolean
deletedboolean
is_publicboolean
created_atstring
updated_atstring

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Groups Get

Returns a group by its ID

Python SDK

zendesk_support.groups.get(
group_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "groups",
"action": "get",
"params": {
"group_id": 0
}
}'

Params

Parameter NameTypeRequiredDescription
group_idintegerYesThe ID of the group
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
namestring
descriptionstring
defaultboolean
deletedboolean
is_publicboolean
created_atstring
updated_atstring

Ticket Comments

Ticket Comments List

Returns a list of comments for a specific ticket

Python SDK

zendesk_support.ticket_comments.list(
ticket_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "ticket_comments",
"action": "list",
"params": {
"ticket_id": 0
}
}'

Params

Parameter NameTypeRequiredDescription
ticket_idintegerYesThe ID of the ticket
pageintegerNoPage number for pagination
include_inline_imagesbooleanNoInclude inline images in the response
sort"created_at" | "-created_at"NoSort order
Response Schema

Records

Field NameTypeDescription
idinteger
typestring
bodystring
html_bodystring
plain_bodystring
publicboolean
author_idinteger
attachmentsarray<object>
audit_idinteger
viaobject
metadataobject
created_atstring

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Attachments

Attachments Get

Returns an attachment by its ID

Python SDK

zendesk_support.attachments.get(
attachment_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "attachments",
"action": "get",
"params": {
"attachment_id": 0
}
}'

Params

Parameter NameTypeRequiredDescription
attachment_idintegerYesThe ID of the attachment
Response Schema

Records

Field NameTypeDescription
idinteger
file_namestring
content_urlstring
mapped_content_urlstring
content_typestring
sizeinteger
widthinteger | null
heightinteger | null
inlineboolean
deletedboolean
malware_access_overrideboolean
malware_scan_resultstring
urlstring
thumbnailsarray<object>

Attachments Download

Downloads the file content of a ticket attachment

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/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "attachments",
"action": "download",
"params": {
"attachment_id": 0
}
}'

Params

Parameter NameTypeRequiredDescription
attachment_idintegerYesThe ID of the attachment
range_headerstringNoOptional Range header for partial downloads (e.g., 'bytes=0-99')

Ticket Audits

Ticket Audits List

Returns a list of all ticket audits

Python SDK

zendesk_support.ticket_audits.list()

API

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

Params

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
Response Schema

Records

Field NameTypeDescription
idinteger
ticket_idinteger
author_idinteger
metadataobject
viaobject
eventsarray<object>
created_atstring

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Ticket Audits List

Returns a list of audits for a specific ticket

Python SDK

zendesk_support.ticket_audits.list(
ticket_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "ticket_audits",
"action": "list",
"params": {
"ticket_id": 0
}
}'

Params

Parameter NameTypeRequiredDescription
ticket_idintegerYesThe ID of the ticket
pageintegerNoPage number for pagination
Response Schema

Records

Field NameTypeDescription
idinteger
ticket_idinteger
author_idinteger
metadataobject
viaobject
eventsarray<object>
created_atstring

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Ticket Metrics

Ticket Metrics List

Returns a list of all ticket metrics

Python SDK

zendesk_support.ticket_metrics.list()

API

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

Params

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
ticket_idinteger
group_stationsinteger
assignee_stationsinteger
reopensinteger
repliesinteger
assignee_updated_atstring | null
requester_updated_atstring
status_updated_atstring
initially_assigned_atstring | null
assigned_atstring | null
solved_atstring | null
latest_comment_added_atstring
reply_time_in_minutesobject
first_resolution_time_in_minutesobject
full_resolution_time_in_minutesobject
agent_wait_time_in_minutesobject
requester_wait_time_in_minutesobject
on_hold_time_in_minutesobject
created_atstring
updated_atstring

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Ticket Fields

Ticket Fields List

Returns a list of all ticket fields

Python SDK

zendesk_support.ticket_fields.list()

API

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

Params

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
localestringNoLocale for the results
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
typestring
titlestring
raw_titlestring
descriptionstring
raw_descriptionstring
positioninteger
activeboolean
requiredboolean
collapsed_for_agentsboolean
regexp_for_validationstring | null
title_in_portalstring
raw_title_in_portalstring
visible_in_portalboolean
editable_in_portalboolean
required_in_portalboolean
tagstring | null
custom_field_optionsarray<object>
system_field_optionsarray<object>
sub_type_idinteger
removableboolean
agent_descriptionstring | null
created_atstring
updated_atstring

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Ticket Fields Get

Returns a ticket field by its ID

Python SDK

zendesk_support.ticket_fields.get(
ticket_field_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "ticket_fields",
"action": "get",
"params": {
"ticket_field_id": 0
}
}'

Params

Parameter NameTypeRequiredDescription
ticket_field_idintegerYesThe ID of the ticket field
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
typestring
titlestring
raw_titlestring
descriptionstring
raw_descriptionstring
positioninteger
activeboolean
requiredboolean
collapsed_for_agentsboolean
regexp_for_validationstring | null
title_in_portalstring
raw_title_in_portalstring
visible_in_portalboolean
editable_in_portalboolean
required_in_portalboolean
tagstring | null
custom_field_optionsarray<object>
system_field_optionsarray<object>
sub_type_idinteger
removableboolean
agent_descriptionstring | null
created_atstring
updated_atstring

Brands

Brands List

Returns a list of all brands for the account

Python SDK

zendesk_support.brands.list()

API

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

Params

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
namestring
brand_urlstring
subdomainstring
host_mappingstring | null
has_help_centerboolean
help_center_statestring
activeboolean
defaultboolean
is_deletedboolean
logoobject | null
ticket_form_idsarray<integer>
signature_templatestring
created_atstring
updated_atstring

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Brands Get

Returns a brand by its ID

Python SDK

zendesk_support.brands.get(
brand_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "brands",
"action": "get",
"params": {
"brand_id": 0
}
}'

Params

Parameter NameTypeRequiredDescription
brand_idintegerYesThe ID of the brand
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
namestring
brand_urlstring
subdomainstring
host_mappingstring | null
has_help_centerboolean
help_center_statestring
activeboolean
defaultboolean
is_deletedboolean
logoobject | null
ticket_form_idsarray<integer>
signature_templatestring
created_atstring
updated_atstring

Views

Views List

Returns a list of all views for the account

Python SDK

zendesk_support.views.list()

API

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

Params

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
access"personal" | "shared" | "account"NoFilter by access level
activebooleanNoFilter by active status
group_idintegerNoFilter by group ID
sort_by"alphabetical" | "created_at" | "updated_at" | "position"NoSort results
sort_order"asc" | "desc"NoSort order
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
titlestring
activeboolean
positioninteger
descriptionstring | null
executionobject
conditionsobject
restrictionobject | null
raw_titlestring
created_atstring
updated_atstring

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Views Get

Returns a view by its ID

Python SDK

zendesk_support.views.get(
view_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "views",
"action": "get",
"params": {
"view_id": 0
}
}'

Params

Parameter NameTypeRequiredDescription
view_idintegerYesThe ID of the view
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
titlestring
activeboolean
positioninteger
descriptionstring | null
executionobject
conditionsobject
restrictionobject | null
raw_titlestring
created_atstring
updated_atstring

Macros

Macros List

Returns a list of all macros for the account

Python SDK

zendesk_support.macros.list()

API

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

Params

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
access"personal" | "shared" | "account"NoFilter by access level
activebooleanNoFilter by active status
categoryintegerNoFilter by category
group_idintegerNoFilter by group ID
only_viewablebooleanNoReturn only viewable macros
sort_by"alphabetical" | "created_at" | "updated_at" | "position"NoSort results
sort_order"asc" | "desc"NoSort order
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
titlestring
activeboolean
positioninteger
descriptionstring
actionsarray<object>
restrictionobject | null
raw_titlestring
created_atstring
updated_atstring

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Macros Get

Returns a macro by its ID

Python SDK

zendesk_support.macros.get(
macro_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "macros",
"action": "get",
"params": {
"macro_id": 0
}
}'

Params

Parameter NameTypeRequiredDescription
macro_idintegerYesThe ID of the macro
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
titlestring
activeboolean
positioninteger
descriptionstring
actionsarray<object>
restrictionobject | null
raw_titlestring
created_atstring
updated_atstring

Triggers

Triggers List

Returns a list of all triggers for the account

Python SDK

zendesk_support.triggers.list()

API

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

Params

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
activebooleanNoFilter by active status
category_idstringNoFilter by category ID
sort"alphabetical" | "created_at" | "updated_at" | "position"NoSort results
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
titlestring
activeboolean
positioninteger
descriptionstring | null
conditionsobject
actionsarray<object>
raw_titlestring
category_idstring
created_atstring
updated_atstring

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Triggers Get

Returns a trigger by its ID

Python SDK

zendesk_support.triggers.get(
trigger_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "triggers",
"action": "get",
"params": {
"trigger_id": 0
}
}'

Params

Parameter NameTypeRequiredDescription
trigger_idintegerYesThe ID of the trigger
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
titlestring
activeboolean
positioninteger
descriptionstring | null
conditionsobject
actionsarray<object>
raw_titlestring
category_idstring
created_atstring
updated_atstring

Automations

Automations List

Returns a list of all automations for the account

Python SDK

zendesk_support.automations.list()

API

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

Params

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
activebooleanNoFilter by active status
sort"alphabetical" | "created_at" | "updated_at" | "position"NoSort results
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
titlestring
activeboolean
positioninteger
conditionsobject
actionsarray<object>
raw_titlestring
created_atstring
updated_atstring

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Automations Get

Returns an automation by its ID

Python SDK

zendesk_support.automations.get(
automation_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "automations",
"action": "get",
"params": {
"automation_id": 0
}
}'

Params

Parameter NameTypeRequiredDescription
automation_idintegerYesThe ID of the automation
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
titlestring
activeboolean
positioninteger
conditionsobject
actionsarray<object>
raw_titlestring
created_atstring
updated_atstring

Tags

Tags List

Returns a list of all tags used in the account

Python SDK

zendesk_support.tags.list()

API

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

Params

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
Response Schema

Records

Field NameTypeDescription
namestring
countinteger

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Satisfaction Ratings

Satisfaction Ratings List

Returns a list of all satisfaction ratings

Python SDK

zendesk_support.satisfaction_ratings.list()

API

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

Params

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
score"offered" | "unoffered" | "received" | "good" | "bad"NoFilter by score
start_timeintegerNoStart time (Unix epoch)
end_timeintegerNoEnd time (Unix epoch)
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
assignee_idinteger | null
group_idinteger | null
requester_idinteger
ticket_idinteger
scorestring
commentstring | null
reasonstring | null
reason_idinteger | null
reason_codeinteger | null
created_atstring
updated_atstring

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Satisfaction Ratings Get

Returns a satisfaction rating by its ID

Python SDK

zendesk_support.satisfaction_ratings.get(
satisfaction_rating_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "satisfaction_ratings",
"action": "get",
"params": {
"satisfaction_rating_id": 0
}
}'

Params

Parameter NameTypeRequiredDescription
satisfaction_rating_idintegerYesThe ID of the satisfaction rating
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
assignee_idinteger | null
group_idinteger | null
requester_idinteger
ticket_idinteger
scorestring
commentstring | null
reasonstring | null
reason_idinteger | null
reason_codeinteger | null
created_atstring
updated_atstring

Group Memberships

Group Memberships List

Returns a list of all group memberships

Python SDK

zendesk_support.group_memberships.list()

API

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

Params

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
user_idinteger
group_idinteger
defaultboolean
created_atstring
updated_atstring

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Organization Memberships

Organization Memberships List

Returns a list of all organization memberships

Python SDK

zendesk_support.organization_memberships.list()

API

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

Params

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
user_idinteger
organization_idinteger
defaultboolean
organization_namestring
view_ticketsboolean
created_atstring
updated_atstring

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Sla Policies

Sla Policies List

Returns a list of all SLA policies

Python SDK

zendesk_support.sla_policies.list()

API

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

Params

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
titlestring
descriptionstring
positioninteger
filterobject
policy_metricsarray<object>
created_atstring
updated_atstring

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Sla Policies Get

Returns an SLA policy by its ID

Python SDK

zendesk_support.sla_policies.get(
sla_policy_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "sla_policies",
"action": "get",
"params": {
"sla_policy_id": 0
}
}'

Params

Parameter NameTypeRequiredDescription
sla_policy_idintegerYesThe ID of the SLA policy
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
titlestring
descriptionstring
positioninteger
filterobject
policy_metricsarray<object>
created_atstring
updated_atstring

Ticket Forms

Ticket Forms List

Returns a list of all ticket forms for the account

Python SDK

zendesk_support.ticket_forms.list()

API

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

Params

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
activebooleanNoFilter by active status
end_user_visiblebooleanNoFilter by end user visibility
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
namestring
display_namestring
raw_namestring
raw_display_namestring
positioninteger
activeboolean
end_user_visibleboolean
defaultboolean
in_all_brandsboolean
restricted_brand_idsarray<integer>
ticket_field_idsarray<integer>
agent_conditionsarray<object>
end_user_conditionsarray<object>
created_atstring
updated_atstring

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Ticket Forms Get

Returns a ticket form by its ID

Python SDK

zendesk_support.ticket_forms.get(
ticket_form_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "ticket_forms",
"action": "get",
"params": {
"ticket_form_id": 0
}
}'

Params

Parameter NameTypeRequiredDescription
ticket_form_idintegerYesThe ID of the ticket form
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
namestring
display_namestring
raw_namestring
raw_display_namestring
positioninteger
activeboolean
end_user_visibleboolean
defaultboolean
in_all_brandsboolean
restricted_brand_idsarray<integer>
ticket_field_idsarray<integer>
agent_conditionsarray<object>
end_user_conditionsarray<object>
created_atstring
updated_atstring

Articles

Articles List

Returns a list of all articles in the Help Center

Python SDK

zendesk_support.articles.list()

API

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

Params

Parameter NameTypeRequiredDescription
pageintegerNoPage number for pagination
sort_by"created_at" | "updated_at" | "title" | "position"NoSort articles by field
sort_order"asc" | "desc"NoSort order
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
html_urlstring
titlestring
bodystring
localestring
author_idinteger
section_idinteger
created_atstring
updated_atstring
vote_suminteger
vote_countinteger
label_namesarray<string>
draftboolean
promotedboolean
positioninteger

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Articles Get

Retrieves the details of a specific article

Python SDK

zendesk_support.articles.get(
id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "articles",
"action": "get",
"params": {
"id": 0
}
}'

Params

Parameter NameTypeRequiredDescription
idintegerYesThe unique ID of the article
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
html_urlstring
titlestring
bodystring
localestring
author_idinteger
section_idinteger
created_atstring
updated_atstring
vote_suminteger
vote_countinteger
label_namesarray<string>
draftboolean
promotedboolean
positioninteger

Article Attachments

Article Attachments List

Returns a list of all attachments for a specific article

Python SDK

zendesk_support.article_attachments.list(
article_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "article_attachments",
"action": "list",
"params": {
"article_id": 0
}
}'

Params

Parameter NameTypeRequiredDescription
article_idintegerYesThe unique ID of the article
pageintegerNoPage number for pagination
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
article_idinteger
file_namestring
content_typestring
content_urlstring
sizeinteger
inlineboolean
created_atstring
updated_atstring

Meta

Field NameTypeDescription
next_pagestring | null
previous_pagestring | null
countinteger

Article Attachments Get

Retrieves the metadata of a specific attachment for a specific article

Python SDK

zendesk_support.article_attachments.get(
article_id=0,
attachment_id=0
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_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
}
}'

Params

Parameter NameTypeRequiredDescription
article_idintegerYesThe unique ID of the article
attachment_idintegerYesThe unique ID of the attachment
Response Schema

Records

Field NameTypeDescription
idinteger
urlstring
article_idinteger
file_namestring
content_typestring
content_urlstring
sizeinteger
inlineboolean
created_atstring
updated_atstring

Article Attachments Download

Downloads the file content of a specific attachment

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/connectors/instances/{your_connector_instance_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
}
}'

Params

Parameter NameTypeRequiredDescription
article_idintegerYesThe unique ID of the article
attachment_idintegerYesThe unique ID of the attachment
range_headerstringNoOptional Range header for partial downloads (e.g., 'bytes=0-99')

Configuration

The connector requires the following configuration variables:

VariableTypeRequiredDefaultDescription
subdomainstringYesyour-subdomainYour Zendesk subdomain

These variables are used to construct the base API URL. Pass them via the config parameter when initializing the connector.

Authentication

The Zendesk-Support connector supports the following authentication methods:

OAuth 2.0

Field NameTypeRequiredDescription
access_tokenstrYesOAuth 2.0 access token
refresh_tokenstrNoOAuth 2.0 refresh token (optional)

Example

Python SDK

ZendeskSupportConnector(
auth_config=ZendeskSupportAuthConfig(
access_token="<OAuth 2.0 access token>",
refresh_token="<OAuth 2.0 refresh token (optional)>"
)
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"connector_definition_id": "79c1aa37-dae3-42ae-b333-d1c105477715",
"auth_config": {
"access_token": "<OAuth 2.0 access token>",
"refresh_token": "<OAuth 2.0 refresh token (optional)>"
},
"name": "My Zendesk-Support Connector"
}'

API Token

Field NameTypeRequiredDescription
emailstrYesYour Zendesk account email address
api_tokenstrYesYour Zendesk API token from Admin Center

Example

Python SDK

ZendeskSupportConnector(
auth_config=ZendeskSupportAuthConfig(
email="<Your Zendesk account email address>",
api_token="<Your Zendesk API token from Admin Center>"
)
)

API

curl --location 'https://api.airbyte.ai/api/v1/connectors/instances' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"connector_definition_id": "79c1aa37-dae3-42ae-b333-d1c105477715",
"auth_config": {
"email": "<Your Zendesk account email address>",
"api_token": "<Your Zendesk API token from Admin Center>"
},
"name": "My Zendesk-Support Connector"
}'