Reference

Endpoint Search Records - NO Sorting (Allows more than 1000 rows)


Name

get_search_export

Description

Search for ticket, user, organization, or group for specified search criteria. Sorting not allowed but you can get more than 1000 records unlike other endpoint for search which supports max 1000 rows but allows sorting if needed. [API reference]

Parameters

Parameter Required Options
Name: query

Label: Search Criteria

The search query based on this syntax https://support.zendesk.com/hc/en-us/articles/203663226
YES
Option Value
Example: Search by Ticket ID 112233
Example: Search by Ticket Status status
Example: Search by Some Text SomeText
Example: Search By Status SomeText
Example: Search by Type and Status type:ticket status:open
Example: Search by Type and Name type:user "Jane Doe"
Example: Search by Type and CreationDate type:organization created< 2015-05-01
Example: Search organizations updated after some date type:organization updated > 2015-05-01
Example: Search users updated after some date type:user updated > 2015-05-01
Example: Search By Type and Tag type:ticket tags:red tags:blue
Name: FilterType

Label: FilterType

Option Value
ticket ticket
organization organization
user user
group group
Name: PageSize

Label: Records Per Page (Max 100)

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.
If the column you are looking for is missing, consider customizing Zendesk Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

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

API Source

API Source - Zendesk
Zendesk Connector can be used to integrate Zendesk REST API in your App / BI Tools. You can read/write data about Tickets, Activity, Users, Organizations and more.
Zendesk
Search Records - NO Sorting (Allows more than 1000 rows)
Required Parameters
Search Criteria Fill-in the parameter...
Optional Parameters
FilterType ticket
SSIS API Source - Read from table or endpoint

API Destination

API Destination - Zendesk
Zendesk Connector can be used to integrate Zendesk REST API in your App / BI Tools. You can read/write data about Tickets, Activity, Users, Organizations and more.
Zendesk
Search Records - NO Sorting (Allows more than 1000 rows)
Required Parameters
Search Criteria Fill-in the parameter...
Optional Parameters
FilterType ticket
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Search records - no sorting

SELECT * FROM get_search_export
WITH
(
    "query" = 'abcd-1234-query'
)

SQL Server

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

Search records - no sorting

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_search_export
WITH
(
    "query" = ''abcd-1234-query''
)';

EXEC (@MyQuery) AT [LS_TO_ZENDESK_IN_GATEWAY];