I’m finalizing work on v1 of my Private App and I have a few Search Actions. My API returns an array to Zapier however Zapier only displays the first record from the array while testing/validating the response and within the Zap editor. How can I properly return a list of records to my users with a Search Action?
Best answer
Search Action Only Returning One Item
- Beginner
Best answer by rmwarner
Just want to close this one out. Sometimes it’s the simple things that can be overlooked, as was the case here. I was so caught up in this being an issue on the development side of things that I didn’t even consider it was an issue with the Zap setup. As
+14- Zapier Orchestrator & Solution Partner
Hi
See screenshots below.
In Zap app actions for searches, there is a field config for: If multiple search results are found
Tooltip: Choose how to handle multiple search results. If you choose to halt, subsequent steps that have fields mapped from this step will not run. If you choose to group, the step may only return a limited number of results. Learn more.
+14- Zapier Orchestrator & Solution Partner
Zapier Developer Platform help links to reference for search actions: https://docs.zapier.com/platform/build/search
3. Set up the API Configuration
In the final API Configuration page, add the API endpoint where Zapier will send the search request to.
A
GETcall is used for search actions by default, and sends the data from the input form to your API endpoint.Zapier expects an array response with 0 or more items.
If multiple matches are found, return a reasonable number of items.
Pagination is not supported, and returning too many results will produce errors.
Although by default Zaps only use the first result, users can decide to group all results as line items.
Other products like Agents will always use all results.
Do not group multiple results as line items yourself, as this will conflict with allowing products and users to control this.
If no matches are found, an empty array must be returned - even if the API responds with a
404status.A search that returns no results is still considered a successful action step and should not return an error.
If you need to parse the response from the endpoint into the expected response type, switch to Code Mode to write custom JavaScript code for your action.
- Beginner
Thanks
I’ve already fully searched the developer docs. My API returns an array but in testing it in the developer platform only one result is shown. The docs don’t help with this at all. To be clear, this isn’t a Zap editor issue. Some other internet searches elude to Zapier only wanting to return a single object for a search action but that can’t possibly be true…
+14- Zapier Orchestrator & Solution Partner
Give us more context by posting screenshots.
Are you returning an object that contains an array OR an array that contains objects?
- Beginner
I know you’re an expert when it comes to the transactional side of Zapier
Zapier doesn’t allow named objects to be returned for search actions. They expect an array and that is what my API is returning. Regardless of the length of the array however Zapier is only displaying the first record in both the testing within the developer platform and the zap builder/engine.
+14- Zapier Orchestrator & Solution Partner
To help us have more context, posting screenshots with how your Zap search action is configured and the DATA IN/OUT along with any errors/warnings.
Have you ever developed a private app in Zapier?
Yes.
+14- Zapier Orchestrator & Solution Partner
Contact page for Zapier Devs: https://developer.zapier.com/contact
- Beginner
- Answer
Just want to close this one out. Sometimes it’s the simple things that can be overlooked, as was the case here. I was so caught up in this being an issue on the development side of things that I didn’t even consider it was an issue with the Zap setup. As
Enter your E-mail address. We'll send you an e-mail with instructions to reset your password.