How do I install the Zendesk-Support full reference skill?

Run npx skillmds@latest add tools-only/zendesk-support-full-reference in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

What does the Zendesk-Support full reference skill do?

This is the full reference documentation for the Zendesk-Support agent connector. It is listed under Coding & Dev Tools on SkillMD.

Is Zendesk-Support full reference safe to use?

This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Zendesk-Support full reference?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Zendesk-Support full reference free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Zendesk-Support full reference?

tools-only (@tools-only) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Zendesk-Support full reference by tools-only

Name: Zendesk-Support full reference
Author: tools-only

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, Get, Search
Users	List, Get, Search
Organizations	List, Get, Search
Groups	List, Get, Search
Ticket Comments	List, Search
Attachments	Get, Download
Ticket Audits	List, List, Search
Ticket Metrics	List, Search
Ticket Fields	List, Get, Search
Brands	List, Get, Search
Views	List, Get
Macros	List, Get
Triggers	List, Get
Automations	List, Get
Tags	List, Search
Satisfaction Ratings	List, Get, Search
Group Memberships	List
Organization Memberships	List
Sla Policies	List, Get
Ticket Forms	List, Get, Search
Articles	List, Get
Article Attachments	List, Get, Download

Tickets

Tickets List

Returns a list of all tickets in your account

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`	`"id" \| "status" \| "updated_at" \| "-id" \| "-status" \| "-updated_at"`	No	Sort order

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`
`created_at`	`string`
`updated_at`	`string`
`via`	`object`

Meta

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

Tickets Get

Returns a ticket by its ID

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

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`
`created_at`	`string`
`updated_at`	`string`
`via`	`object`

Tickets 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.

Python SDK

await zendesk_support.tickets.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": "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, like, 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 next_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
`via`	`object`	Object describing the channel and method through which the ticket was created

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

Users

Users List

Returns a list of all users in your account

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

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 Get

Returns a user by their ID

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

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

Python SDK

await zendesk_support.users.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": "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, like, 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 next_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

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

Organizations

Organizations List

Returns a list of all organizations in your account

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

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

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

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

Python SDK

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

Field Name	Type	Description
`hits`	`array`	List of matching records
`hits[].id`	`string`	Record identifier
`hits[].score`	`number`	Relevance score
`hits[].data`	`object`	Record data containing the searchable fields listed above
`hits[].data.created_at`	`string`	Timestamp when the organization was created
`hits[].data.deleted_at`	`string`	Timestamp when the organization was deleted
`hits[].data.details`	`string`	Details about the organization, such as the address
`hits[].data.domain_names`	`array`	Array of domain names associated with this organization for automatic user assignment
`hits[].data.external_id`	`string`	Unique external identifier to associate the organization to an external record (case-insensitive)
`hits[].data.group_id`	`integer`	ID of the group where new tickets from users in this organization are automatically assigned
`hits[].data.id`	`integer`	Unique identifier automatically assigned when the organization is created
`hits[].data.name`	`string`	Unique name for the organization (mandatory field)
`hits[].data.notes`	`string`	Notes about the organization
`hits[].data.organization_fields`	`object`	Key-value object for custom organization fields
`hits[].data.shared_comments`	`boolean`	Boolean indicating whether end users in this organization can comment on each other's tickets
`hits[].data.shared_tickets`	`boolean`	Boolean indicating whether end users in this organization can see each other's tickets
`hits[].data.tags`	`array`	Array of tags associated with the organization
`hits[].data.updated_at`	`string`	Timestamp of the last update to the organization
`hits[].data.url`	`string`	The API URL of this organization
`next_cursor`	`string \| null`	Cursor for next page of results
`took_ms`	`number`	Query execution time in milliseconds

Groups

Groups List

Returns a list of all groups in your account

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

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

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_to

…(truncated)

Zendesk-Support full reference

File contents

Zendesk-Support full reference

Supported entities and actions

Tickets

Tickets List

Python SDK

API

Parameters

Records

Meta

Tickets Get

Python SDK

API

Parameters

Records

Tickets Search

Python SDK

API

Parameters

Searchable Fields

Users

Users List

Python SDK

API

Parameters

Records

Meta

Users Get

Python SDK

API

Parameters

Records

Users Search

Python SDK

API

Parameters

Searchable Fields

Organizations

Organizations List

Python SDK

API

Parameters

Records

Meta

Organizations Get

Python SDK

API

Parameters

Records

Organizations Search

Python SDK

API

Parameters

Searchable Fields

Groups

Groups List

Python SDK

API

Parameters

Records

Meta

Groups Get

Python SDK

API

Related skills

Frequently asked questions

How do I install the Zendesk-Support full reference skill?

What does the Zendesk-Support full reference skill do?

Is Zendesk-Support full reference safe to use?

Which AI agents work with Zendesk-Support full reference?

Is Zendesk-Support full reference free to use?

Who published Zendesk-Support full reference?