This connector is optimized for AI agents. For the data replication connector, see Zendesk Chat .
This is the full reference documentation for the Zendesk-Chat agent connector.
Supported entities and actions
The Zendesk-Chat connector supports the following entities and actions.
Entity Actions Accounts Get Agents List , Get , Search Agent Timeline List Bans List , Get Chats List , Get , Search Departments List , Get , Search Goals List , Get Roles List , Get Routing Settings Get Shortcuts List , Get , Search Skills List , Get Triggers List , Search
Accounts
Accounts Get
Returns the account information for the authenticated user
Python SDK
await zendesk_chat . accounts . get ( )
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": "accounts", "action": "get" }'
Response Schema Records Field Name Type Description account_keystringstatusstring | nullcreate_datestring | nullbillingobject | anyplanobject | any
Agents
Agents List
List all agents
Python SDK
await zendesk_chat . agents . 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": "agents", "action": "list" }'
Parameters
Parameter Name Type Required Description limitintegerNo since_idintegerNo
Response Schema Records Field Name Type Description idintegeremailstring | nulldisplay_namestring | nullfirst_namestring | nulllast_namestring | nullenabledboolean | nullrole_idinteger | nullrolesobject | anydepartmentsarray | nullenabled_departmentsarray | nullskillsarray | nullscopestring | nullcreate_datestring | nulllast_loginstring | nulllogin_countinteger | null
Agents Get
Get an agent
Python SDK
await zendesk_chat . agents . get ( agent_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": "agents", "action": "get", "params": { "agent_id": 0 } }'
Parameters
Parameter Name Type Required Description agent_idintegerYes
Response Schema Records Field Name Type Description idintegeremailstring | nulldisplay_namestring | nullfirst_namestring | nulllast_namestring | nullenabledboolean | nullrole_idinteger | nullrolesobject | anydepartmentsarray | nullenabled_departmentsarray | nullskillsarray | nullscopestring | nullcreate_datestring | nulllast_loginstring | nulllogin_countinteger | null
Agents Search
Search and filter agents 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.
Python SDK
await zendesk_chat . agents . 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": "agents", "action": "search", "params": { "query": {"filter": {"eq": {"id": 0}}} } }'
Parameters
Parameter Name Type Required Description queryobjectYes Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or query.filterobjectNo Filter conditions query.sortarrayNo Sort conditions limitintegerNo Maximum results to return (default 1000) cursorstringNo Pagination cursor from previous response's meta.cursor fieldsarrayNo Field paths to include in results
Searchable Fields
Field Name Type Description idintegerUnique agent identifier emailstringAgent email address display_namestringAgent display name first_namestringAgent first name last_namestringAgent last name enabledbooleanWhether agent is enabled role_idintegerAgent role ID departmentsarrayDepartment IDs agent belongs to create_datestringWhen agent was created
Response Schema Field Name Type Description dataarrayList of matching records metaobjectPagination metadata meta.has_morebooleanWhether additional pages are available meta.cursorstring | nullCursor for next page of results meta.took_msnumber | nullQuery execution time in milliseconds data[].idintegerUnique agent identifier data[].emailstringAgent email address data[].display_namestringAgent display name data[].first_namestringAgent first name data[].last_namestringAgent last name data[].enabledbooleanWhether agent is enabled data[].role_idintegerAgent role ID data[].departmentsarrayDepartment IDs agent belongs to data[].create_datestringWhen agent was created
Agent Timeline
Agent Timeline List
List agent timeline (incremental export)
Python SDK
await zendesk_chat . agent_timeline . 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": "agent_timeline", "action": "list" }'
Parameters
Parameter Name Type Required Description start_timeintegerNo limitintegerNo fieldsstringNo
Response Schema Records Field Name Type Description agent_idintegerstart_timestring | nullstatusstring | nulldurationnumber | nullengagement_countinteger | null
Field Name Type Description next_pagestring | nullcountinteger
Bans
Bans List
List all bans
Python SDK
await zendesk_chat . bans . 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": "bans", "action": "list" }'
Parameters
Parameter Name Type Required Description limitintegerNo since_idintegerNo
Bans Get
Get a ban
Python SDK
await zendesk_chat . bans . get ( ban_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": "bans", "action": "get", "params": { "ban_id": 0 } }'
Parameters
Parameter Name Type Required Description ban_idintegerYes
Response Schema Records Field Name Type Description idintegertypestring | nullip_addressstring | nullvisitor_idstring | nullvisitor_namestring | nullreasonstring | nullcreated_atstring | null
Chats
Chats List
List chats (incremental export)
Python SDK
await zendesk_chat . chats . 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": "chats", "action": "list" }'
Parameters
Parameter Name Type Required Description start_timeintegerNo limitintegerNo fieldsstringNo
Response Schema Records Field Name Type Description idstringtypestring | nulltimestampstring | nullupdate_timestampstring | nulldurationinteger | nulldepartment_idinteger | nulldepartment_namestring | nullagent_idsarray | nullagent_namesarray | nullvisitorobject | anysessionobject | anyhistoryarray | nullhistory[].typestring | nullhistory[].timestampstring | nullhistory[].namestring | nullhistory[].nickstring | nullhistory[].msgstring | nullhistory[].msg_idstring | nullhistory[].channelstring | nullhistory[].department_idinteger | nullhistory[].department_namestring | nullhistory[].ratingstring | nullhistory[].new_ratingstring | nullhistory[].tagsarray | nullhistory[].new_tagsarray | nullhistory[].optionsstring | nullengagementsarray | nullengagements[].idstring | nullengagements[].agent_idstring | nullengagements[].agent_namestring | nullengagements[].agent_full_namestring | nullengagements[].department_idinteger | nullengagements[].timestampstring | nullengagements[].durationnumber | nullengagements[].acceptedboolean | nullengagements[].assignedboolean | nullengagements[].started_bystring | nullengagements[].ratingstring | nullengagements[].commentstring | nullengagements[].countobject | anyengagements[].response_timeobject | anyengagements[].skills_requestedarray | nullengagements[].skills_fulfilledboolean | nullconversionsarray | nullconversions[].idstring | nullconversions[].goal_idinteger | nullconversions[].goal_namestring | nullconversions[].timestampstring | nullconversions[].attributionobject | anycountobject | anyresponse_timeobject | anyratingstring | nullcommentstring | nulltagsarray | nullstarted_bystring | nulltriggeredboolean | nulltriggered_responseboolean | nullmissedboolean | nullunreadboolean | nulldeletedboolean | nullmessagestring | nullwebpatharray | nullwebpath[].fromstring | nullwebpath[].timestampstring | nullzendesk_ticket_idinteger | null
Field Name Type Description next_pagestring | nullcountinteger
Chats Get
Get a chat
Python SDK
await zendesk_chat . chats . get ( chat_id = "<str>" )
API
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {your_auth_token}' \ --data '{ "entity": "chats", "action": "get", "params": { "chat_id": "<str>" } }'
Parameters
Parameter Name Type Required Description chat_idstringYes
Response Schema Records Field Name Type Description idstringtypestring | nulltimestampstring | nullupdate_timestampstring | nulldurationinteger | nulldepartment_idinteger | nulldepartment_namestring | nullagent_idsarray | nullagent_namesarray | nullvisitorobject | anysessionobject | anyhistoryarray | nullhistory[].typestring | nullhistory[].timestampstring | nullhistory[].namestring | nullhistory[].nickstring | nullhistory[].msgstring | nullhistory[].msg_idstring | nullhistory[].channelstring | nullhistory[].department_idinteger | nullhistory[].department_namestring | nullhistory[].ratingstring | nullhistory[].new_ratingstring | nullhistory[].tagsarray | nullhistory[].new_tagsarray | nullhistory[].optionsstring | nullengagementsarray | nullengagements[].idstring | nullengagements[].agent_idstring | nullengagements[].agent_namestring | nullengagements[].agent_full_namestring | nullengagements[].department_idinteger | nullengagements[].timestampstring | nullengagements[].durationnumber | nullengagements[].acceptedboolean | nullengagements[].assignedboolean | nullengagements[].started_bystring | nullengagements[].ratingstring | nullengagements[].commentstring | nullengagements[].countobject | anyengagements[].response_timeobject | anyengagements[].skills_requestedarray | nullengagements[].skills_fulfilledboolean | nullconversionsarray | nullconversions[].idstring | nullconversions[].goal_idinteger | nullconversions[].goal_namestring | nullconversions[].timestampstring | nullconversions[].attributionobject | anycountobject | anyresponse_timeobject | anyratingstring | nullcommentstring | nulltagsarray | nullstarted_bystring | nulltriggeredboolean | nulltriggered_responseboolean | nullmissedboolean | nullunreadboolean | nulldeletedboolean | nullmessagestring | nullwebpatharray | nullwebpath[].fromstring | nullwebpath[].timestampstring | nullzendesk_ticket_idinteger | null
Chats Search
Search and filter chats 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.
Python SDK
await zendesk_chat . chats . search ( query = { "filter" : { "eq" : { "id" : "<str>" } } } )
API
curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {your_auth_token}' \ --data '{ "entity": "chats", "action": "search", "params": { "query": {"filter": {"eq": {"id": "<str>"}}} } }'
Parameters
Parameter Name Type Required Description queryobjectYes Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or query.filterobjectNo Filter conditions query.sortarrayNo Sort conditions limitintegerNo Maximum results to return (default 1000) cursorstringNo Pagination cursor from previous response's meta.cursor fieldsarrayNo Field paths to include in results
Searchable Fields
Field Name Type Description idstringUnique chat identifier timestampstringChat start timestamp update_timestampstringLast update timestamp department_idintegerDepartment ID department_namestringDepartment name durationintegerChat duration in seconds ratingstringSatisfaction rating missedbooleanWhether chat was missed agent_idsarrayIDs of agents in chat
Response Schema Field Name Type Description dataarrayList of matching records metaobjectPagination metadata meta.has_morebooleanWhether additional pages are available meta.cursorstring | nullCursor for next page of results meta.took_msnumber | nullQuery execution time in milliseconds data[].idstringUnique chat identifier data[].timestampstringChat start timestamp data[].update_timestampstringLast update timestamp data[].department_idintegerDepartment ID data[].department_namestringDepartment name data[].durationintegerChat duration in seconds data[].ratingstringSatisfaction rating data[].missedbooleanWhether chat was missed data[].agent_idsarrayIDs of agents in chat
Departments
Departments List
List all departments
Python SDK
await zendesk_chat . departments . 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": "departments", "action": "list" }'
Response Schema Records Field Name Type Description idintegernamestring | nulldescriptionstring | nullenabledboolean | nullmembersarray | nullsettingsobject | any
Departments Get
Get a department
Python SDK
await zendesk_chat . departments . get ( department_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": "departments", "action": "get", "params": { "department_id": 0 } }'
Parameters
Parameter Name Type Required Description department_idintegerYes
Response Schema Records Field Name Type Description idintegernamestring | nulldescriptionstring | nullenabledboolean | nullmembersarray | nullsettingsobject | any
Departments Search
Search and filter departments 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.
Python SDK
await zendesk_chat . departments . 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": "departments", "action": "search", "params": { "query": {"filter": {"eq": {"id": 0}}} } }'
Parameters
Parameter Name Type Required Description queryobjectYes Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or query.filterobjectNo Filter conditions query.sortarrayNo Sort conditions limitintegerNo Maximum results to return (default 1000) cursorstringNo Pagination cursor from previous response's meta.cursor fieldsarrayNo Field paths to include in results
Searchable Fields
Field Name Type Description idintegerDepartment ID namestringDepartment name enabledbooleanWhether department is enabled membersarrayAgent IDs in department
Response Schema Field Name Type Description dataarrayList of matching records metaobjectPagination metadata meta.has_morebooleanWhether additional pages are available meta.cursorstring | nullCursor for next page of results meta.took_msnumber | nullQuery execution time in milliseconds data[].idintegerDepartment ID data[].namestringDepartment name data[].enabledbooleanWhether department is enabled data[].membersarrayAgent IDs in department
Goals
Goals List
List all goals
Python SDK
await zendesk_chat . goals . 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": "goals", "action": "list" }'
Response Schema Records Field Name Type Description idintegernamestring | nulldescriptionstring | nullenabledboolean | nullattribution_modelstring | nullattribution_windowinteger | nullattribution_periodinteger | nullsettingsobject | null
Goals Get
Get a goal
Python SDK
await zendesk_chat . goals . get ( goal_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": "goals", "action": "get", "params": { "goal_id": 0 } }'
Parameters
Parameter Name Type Required Description goal_idintegerYes
Response Schema Records Field Name Type Description idintegernamestring | nulldescriptionstring | nullenabledboolean | nullattribution_modelstring | nullattribution_windowinteger | nullattribution_periodinteger | nullsettingsobject | null
Roles
Roles List
List all roles
Python SDK
await zendesk_chat . roles . 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": "roles", "action": "list" }'
Response Schema Records Field Name Type Description idintegernamestring | nulldescriptionstring | nullenabledboolean | nullpermissionsobject | nullmembers_countinteger | null
Roles Get
Get a role
Python SDK
await zendesk_chat . roles . get ( role_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": "roles", "action": "get", "params": { "role_id": 0 } }'
Parameters
Parameter Name Type Required Description role_idintegerYes
Response Schema Records Field Name Type Description idintegernamestring | nulldescriptionstring | nullenabledboolean | nullpermissionsobject | nullmembers_countinteger | null
Routing Settings
Routing Settings Get
Get routing settings
Python SDK
await zendesk_chat . routing_settings . get ( )
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": "routing_settings", "action": "get" }'
Response Schema Records Field Name Type Description routing_modestring | nullchat_limitobject | nullskill_routingobject | nullreassignmentobject | nullauto_idleobject | nullauto_acceptobject | null
Shortcuts
Shortcuts List
List all shortcuts
Python SDK
await zendesk_chat . shortcuts . 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": "shortcuts", "action": "list" }'
Response Schema Records Field Name Type Description idstringnamestring | nullmessagestring | nulloptionsstring | nulltagsarray | nulldepartmentsarray | nullagentsarray | nullscopestring | null
Shortcuts Get
Get a shortcut
Python SDK
await zendesk_chat . shortcuts . get ( shortcut_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": "shortcuts", "action": "get", "params": { "shortcut_id": 0 } }'
Parameters
Parameter Name Type Required Description shortcut_idintegerYes
Response Schema Records Field Name Type Description idstringnamestring | nullmessagestring | nulloptionsstring | nulltagsarray | nulldepartmentsarray | nullagentsarray | nullscopestring | null
Shortcuts Search
Search and filter shortcuts 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.
Python SDK
await zendesk_chat . shortcuts . 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": "shortcuts", "action": "search", "params": { "query": {"filter": {"eq": {"id": 0}}} } }'
Parameters
Parameter Name Type Required Description queryobjectYes Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or query.filterobjectNo Filter conditions query.sortarrayNo Sort conditions limitintegerNo Maximum results to return (default 1000) cursorstringNo Pagination cursor from previous response's meta.cursor fieldsarrayNo Field paths to include in results
Searchable Fields
Field Name Type Description idintegerShortcut ID namestringShortcut name/trigger messagestringShortcut message content tagsarrayTags applied when shortcut is used
Response Schema Field Name Type Description dataarrayList of matching records metaobjectPagination metadata meta.has_morebooleanWhether additional pages are available meta.cursorstring | nullCursor for next page of results meta.took_msnumber | nullQuery execution time in milliseconds data[].idintegerShortcut ID data[].namestringShortcut name/trigger data[].messagestringShortcut message content data[].tagsarrayTags applied when shortcut is used
Skills
Skills List
List all skills
Python SDK
await zendesk_chat . skills . 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": "skills", "action": "list" }'
Response Schema Records Field Name Type Description idintegernamestring | nulldescriptionstring | nullenabledboolean | nullmembersarray | null
Skills Get
Get a skill
Python SDK
await zendesk_chat . skills . get ( skill_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": "skills", "action": "get", "params": { "skill_id": 0 } }'
Parameters
Parameter Name Type Required Description skill_idintegerYes
Response Schema Records Field Name Type Description idintegernamestring | nulldescriptionstring | nullenabledboolean | nullmembersarray | null
Triggers
Triggers List
List all triggers
Python SDK
await zendesk_chat . 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" }'
Response Schema Records Field Name Type Description idintegernamestring | nulldescriptionstring | nullenabledboolean | nullrun_onceboolean | nullconditionsarray | nullactionsarray | nulldepartmentsarray | nulldefinitionobject | null
Triggers 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.
Python SDK
await zendesk_chat . triggers . 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": "search", "params": { "query": {"filter": {"eq": {"id": 0}}} } }'
Parameters
Parameter Name Type Required Description queryobjectYes Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or query.filterobjectNo Filter conditions query.sortarrayNo Sort conditions limitintegerNo Maximum results to return (default 1000) cursorstringNo Pagination cursor from previous response's meta.cursor fieldsarrayNo Field paths to include in results
Searchable Fields
Field Name Type Description idintegerTrigger ID namestringTrigger name enabledbooleanWhether trigger is enabled
Response Schema Field Name Type Description dataarrayList of matching records metaobjectPagination metadata meta.has_morebooleanWhether additional pages are available meta.cursorstring | nullCursor for next page of results meta.took_msnumber | nullQuery execution time in milliseconds data[].idintegerTrigger ID data[].namestringTrigger name data[].enabledbooleanWhether trigger is enabled