Zendesk Connector
Documentation
Version: 9
Documentation
Endpoint

Read Requests Search

Name

get_requests_search

Description

Returns a requests using search criteria. [API reference]

Parameters

Parameter Label Required Options Description
query Search Criteria 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
The search query based on this syntax https://support.zendesk.com/hc/en-us/articles/203663226
sort_by Sort By NO
Option Value
updated_at updated_at
created_at created_at
Sort By field
sort_order Sort Order NO
Option Value
desc desc
asc asc
Sort order
status Status NO
Option Value
new new
open open
pending pending
solved solved
closed closed
Sort order
organization_id organization_id NO
cc_id cc_id NO

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw 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 Raw 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 component to read data or in API Destination component to read/write data:

Read Requests Search using API Source

Zendesk
Read Requests Search
SSIS API Source - Read from table or endpoint

Read Requests Search using API Destination

Zendesk
Read Requests Search
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Read requests search 

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

SQL Server

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

Read requests search 

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

EXEC (@MyQuery) AT [LS_TO_ZENDESK_IN_GATEWAY];