ZendeskSearch
Finds tickets, users, organizations or groups with a Zendesk search query.
Settings
| Setting | What it is |
|---|---|
| ConnectionRequired | The Zendesk connection the step signs in with. |
| What to search | "ticket" or "user" or "organization" or "group" |
| QueryRequired | Zendesk's own search language. The node adds the kind from the dropdown above, so do not write it here again. |
| Order by | "" or "updated_at" or "created_at" or "priority" or "status" or "ticket_type" |
| Direction | "desc" or "asc" |
| Results per call | 1 to 100. |
| Fetch every page | Off, Zendesk answers at most 1,000 results however wide the query is. On, the node uses Zendesk's export lane instead, which has no such ceiling but always orders by creation date — so the order fields disappear. It refuses past 5,000 results rather than answering a short list. |
| Cursor | Paste a previous run's Next cursor to read the page after it. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `zendesk`) |
type | "ticket" or "user" or "organization" or "group", by default "ticket" |
query | text |
sortBy | "" or "updated_at" or "created_at" or "priority" or "status" or "ticket_type"used when `returnAll` is false |
sortOrder | "desc" or "asc", by default "desc"used when `returnAll` is false |
limit | number, by default 100used when `returnAll` is false |
returnAll | true/false, by default false |
cursor | text |
Output
| Field | Type |
|---|---|
results | array |
resultCountResults in this answer | number |
hasMoreMore results are waiting behind this page | boolean |
nextCursorCursor for the next page | string |
totalMatchesHow many records match in total | number |
Sample output, and the expression for each field
- hasMorefalse
- nextCursor""
- resultCount0
- results[]
- totalMatches0
Errors
When a step of this node stops a run, the run page shows a code. Look it up:
Example step
The step as a flow file holds it. Replace each value in <…>.
{
"config": {
"connection": "<connection id>",
"cursor": "",
"limit": 100,
"query": "<query>",
"returnAll": false,
"sortBy": "",
"sortOrder": "desc",
"type": "ticket"
},
"label": "Search",
"type": "zendesk.search",
"version": 2
}Older versions
A flow that already has this version keeps running it. A new step always gets the newest.
Version 1
| Setting | What it is |
|---|---|
| ConnectionRequired | The Zendesk connection the step signs in with. |
| What to search | "ticket" or "user" or "organization" or "group" |
| QueryRequired | Zendesk's own search language. The node adds the kind from the dropdown above, so do not write it here again. |
| Order by | "" or "updated_at" or "created_at" or "priority" or "status" or "ticket_type" |
| Direction | "desc" or "asc" |
| Results per call | 1 to 100. |
| Fetch every page | Off, Zendesk answers at most 1,000 results however wide the query is. On, the node uses Zendesk's export lane instead, which has no such ceiling but always orders by creation date — so the order fields disappear. It refuses past 5,000 results rather than answering a short list. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `zendesk`) |
type | "ticket" or "user" or "organization" or "group", by default "ticket" |
query | text |
sortBy | "" or "updated_at" or "created_at" or "priority" or "status" or "ticket_type"used when `returnAll` is false |
sortOrder | "desc" or "asc", by default "desc"used when `returnAll` is false |
limit | number, by default 100used when `returnAll` is false |
returnAll | true/false, by default false |