Channel query in Requests API

Answered

Posted Apr 21, 2022

Currently looking to use the `query` param in the Requests API (/api/v2/requests) to ONLY return tickets created using a specific channel (for example: "native_messaging". Is that possible? Not sure how to use zendesk query in this case since it's a nested data object

The response would normally look something like this:
{
...
"via": { "channel": "native_messaging" }
}

I've tried the following but none seem to work:

/api/v2/requests.json?query=via:channel=messaging
/api/v2/requests.json?query=via:messaging
/api/v2/requests.json?query=channel:messaging

Thanks in advance for any help!

6 comments

Date

Jack

Apr 21, 2022

Hi Xinran!

Is it possible you want to use the https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-requests/#search-requests search requests endpoint instead?

Xinran Wang

Apr 21, 2022

Oh whoa. That worked. Thanks!

Do you know if there are any major differences between the 2 APIs other than being able to use "query"?

Greg Katechis

Zendesk Developer Advocacy

Apr 21, 2022

Hi Xinran! The Search Requests endpoint gives you access to the query param, which thereby gives you access to all of this. You can also use pagination with Search Requests, which can be very useful depending on the tasks that you are using it for.