EndPoint Search Records
Name
get_search
Description
Search for ticket, user, organization, or group for specified search criteria. Returns max 1000 records based on search criteria (i.e. query) you specify
[API Help]
Parameters
Parameter |
Label |
Required |
Options |
Description |
query |
Search Criteria |
YES |
Option |
Value |
Example: Search by Ticket ID |
112233 |
Example: Search by Ticket Status |
status<solved |
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 |
priority |
priority |
status |
status |
ticket_type |
ticket_type |
|
|
sort_order |
Sort Order |
NO |
Option |
Value |
desc |
desc |
asc |
asc |
|
|
include |
Extra Columns to Include |
NO |
Option |
Value |
Default |
|
users |
users |
|
You can list email CCs by side-loading users.
|
Output Columns
Label |
DataType |
Length |
Raw |
Description |
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. |
Input Columns
Label |
DataType |
Length |
Raw |
Description |
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. |