Reference

Endpoint Read Tickets (All)

Name

get_tickets

Description

Get a list of all tickets in your account [API reference]

Related Tables

Tickets (Row by Row) , Tickets (Bulk)

Parameters

Parameter Required Options
Name: sort_by

Label: Sort By

Sort By field
Option Value
id id
assignee assignee
assignee.name assignee.name
created_at created_at
group group
locale locale
requester requester
requester.name requester.name
status status
subject subject
updated_at updated_at
Name: sort_order

Label: Sort Order

Sort order
Option Value
desc desc
asc asc
Name: include

Label: Extra Columns to Include
Option Value
Default
comment_count comment_count
Name: external_id

Label: External ID for Ticket
Name: PageSize

Label: Records Per Page (Max 100)

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
id DT_I8 bigint
recipient DT_WSTR nvarchar(255) 255
subject DT_WSTR nvarchar(1000) 1000
status DT_WSTR nvarchar(28) 28
type DT_WSTR nvarchar(255) 255
priority DT_WSTR nvarchar(24) 24
description DT_NTEXT nvarchar(MAX)
external_id DT_WSTR nvarchar(255) 255
created_at DT_DBTIMESTAMP datetime
updated_at DT_DBTIMESTAMP datetime
raw_subject DT_WSTR nvarchar(1000) 1000
url DT_WSTR nvarchar(500) 500
comment_count DT_I8 bigint
requester_id DT_I8 bigint
submitter_id DT_I8 bigint
assignee_id DT_I8 bigint
organization_id DT_I8 bigint
group_id DT_I8 bigint
collaborator_ids DT_WSTR nvarchar(1000) 1000
collaborator_ids_1 DT_WSTR nvarchar(20) 20
collaborator_ids_2 DT_WSTR nvarchar(20) 20
collaborator_ids_3 DT_WSTR nvarchar(20) 20
follower_ids DT_WSTR nvarchar(1000) 1000
follower_ids_1 DT_WSTR nvarchar(20) 20
follower_ids_2 DT_WSTR nvarchar(20) 20
follower_ids_3 DT_WSTR nvarchar(20) 20
email_cc_ids DT_WSTR nvarchar(1000) 1000
email_cc_ids_1 DT_WSTR nvarchar(20) 20
email_cc_ids_2 DT_WSTR nvarchar(20) 20
email_cc_ids_3 DT_WSTR nvarchar(20) 20
forum_topic_id DT_WSTR nvarchar(255) 255
problem_id DT_WSTR nvarchar(255) 255
has_incidents DT_BOOL bit
is_public DT_BOOL bit
due_at DT_DBTIMESTAMP datetime
tags DT_WSTR nvarchar(1000) 1000
tags_1 DT_WSTR nvarchar(50) 50
tags_2 DT_WSTR nvarchar(50) 50
tags_3 DT_WSTR nvarchar(50) 50
tags_4 DT_WSTR nvarchar(50) 50
tags_5 DT_WSTR nvarchar(50) 50
custom_fields DT_WSTR nvarchar(1000) 1000
custom_fields_1_id DT_WSTR nvarchar(20) 20
custom_fields_1_value DT_WSTR nvarchar(1000) 1000
custom_fields_2_id DT_WSTR nvarchar(20) 20
custom_fields_2_value DT_WSTR nvarchar(1000) 1000
custom_fields_3_id DT_WSTR nvarchar(20) 20
custom_fields_3_value DT_WSTR nvarchar(1000) 1000
custom_fields_4_id DT_WSTR nvarchar(20) 20
custom_fields_4_value DT_WSTR nvarchar(1000) 1000
custom_fields_5_id DT_WSTR nvarchar(20) 20
custom_fields_5_value DT_WSTR nvarchar(1000) 1000
via_followup_source_id DT_I8 bigint
satisfaction_rating_id DT_I8 bigint
satisfaction_rating_score DT_WSTR nvarchar(20) 20
satisfaction_rating_comment DT_WSTR nvarchar(1000) 1000
sharing_agreement_ids DT_WSTR nvarchar(255) 255
fields DT_WSTR nvarchar(1000) 1000
followup_ids DT_WSTR nvarchar(1000) 1000
brand_id DT_I8 bigint
allow_channelback DT_BOOL bit
allow_attachments DT_BOOL bit
via_channel DT_WSTR nvarchar(100) 100
via_source_rel DT_WSTR nvarchar(255) 255
via_source_from_address DT_WSTR nvarchar(500) 500
via_source_from_name DT_WSTR nvarchar(500) 500
via_source_to_name DT_WSTR nvarchar(500) 500
via_source_to_address DT_WSTR nvarchar(500) 500
via_source_from_ticket_id DT_I8 bigint
via_source_from_subject DT_WSTR nvarchar(1000) 1000
via_source_from_channel DT_WSTR nvarchar(50) 50
custom_field_[$parent.id$] DT_WSTR nvarchar(4000) 4000
If the column you are looking for is missing, consider customizing Zendesk Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
subject DT_WSTR nvarchar(1012) 1012
recipient DT_WSTR nvarchar(255) 255
status DT_WSTR nvarchar(28) 28
type DT_WSTR nvarchar(255) 255
priority DT_WSTR nvarchar(24) 24
comment_body DT_NTEXT nvarchar(MAX)
comment_body_html DT_NTEXT nvarchar(MAX)
comment_public DT_BOOL bit
comment_author_id DT_I8 bigint
tags DT_WSTR nvarchar(1000) 1000
custom_fields DT_WSTR nvarchar(1000) 1000
external_id DT_WSTR nvarchar(255) 255
requester_name DT_WSTR nvarchar(255) 255
requester_email DT_WSTR nvarchar(255) 255
requester_id DT_I8 bigint
submitter_id DT_I8 bigint
assignee_id DT_I8 bigint
organization_id DT_I8 bigint
group_id DT_I8 bigint
collaborator_ids DT_WSTR nvarchar(1000) 1000
follower_ids DT_WSTR nvarchar(1000) 1000
email_cc_ids DT_WSTR nvarchar(1000) 1000
forum_topic_id DT_WSTR nvarchar(255) 255
problem_id DT_WSTR nvarchar(255) 255
is_public DT_BOOL bit
due_at DT_DBTIMESTAMP datetime
sharing_agreement_ids DT_WSTR nvarchar(255) 255
fields DT_WSTR nvarchar(1000) 1000
followup_ids DT_WSTR nvarchar(1000) 1000
brand_id DT_I8 bigint
allow_channelback DT_BOOL bit
allow_attachments DT_BOOL bit
Required columns that you need to supply are bolded.

Examples

SSIS

Use Zendesk Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the Tickets (Row by Row) table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Zendesk
Read and write Zendesk data effortlessly. Manage tickets, users, and organizations — almost no coding required.
Zendesk
Tickets (Row by Row)
Optional Parameters
Sort By
Sort Order
Extra Columns to Include
External ID for Ticket
NextUrlAttributeOrExpr $.links.next
Records Per Page (Max 100) 100
NextUrlEndIndicator false
StopIndicatorAttributeOrExpr $.meta.has_more
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Tickets (Row by Row) table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to read tickets:

API Destination - Zendesk
Read and write Zendesk data effortlessly. Manage tickets, users, and organizations — almost no coding required.
Zendesk
Tickets (Row by Row)
Select
Optional Parameters
Sort By
Sort Order
Extra Columns to Include
External ID for Ticket
NextUrlAttributeOrExpr $.links.next
Records Per Page (Max 100) 100
NextUrlEndIndicator false
StopIndicatorAttributeOrExpr $.meta.has_more
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Read tickets

<p>Reads all tickets from the Zendesk account. This example demonstrates a basic SELECT query to retrieve a complete list of tickets from the <code>Tickets</code> table.</p> 

SELECT * FROM Tickets

get_tickets endpoint belongs to Tickets , Tickets_Bulk table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Read tickets

<p>Reads all tickets from the Zendesk account. This example demonstrates a basic SELECT query to retrieve a complete list of tickets from the <code>Tickets</code> table.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Tickets';

EXEC (@MyQuery) AT [LS_TO_ZENDESK_IN_GATEWAY];

get_tickets endpoint belongs to Tickets , Tickets_Bulk table(s), and can therefore be used via those table(s).