Find Requests

find requests you can find (or search) the requests in a collection by making making a http get request to the /collections/collection id/requests/page?q=xyz endpoint (where collection id is the id of the collection to get requests for, page is the page of matching requests to get and the q querystring parameter is the search term to search for) this endpoint is particuarly useful if you are allowing your users to modify the requests within collections on your ui as you can allow them to search through all of the requests in the collection to find the one they'd like to modify concurrency when finding requests you should make calls to the find request endpoint sequentially, rather than in parallel if you make too many concurrent calls you will receive an http 429 error example get get /collections/collection id/requests/page?q=xyz in the example below we return page 1 of the requests from the collection with id=123456 that match the search term test (note the search term is specified using the "q" querystring parameter) searching by custom ids redcircle api will look for the q parameter in the request and in the custom id (if any) you assigned to the request this way it's easy to find requests using the custom id from your app http https //api redcircleapi com/collections/123456/requests/1?api key=demo\&q=test$ curl "https //api redcircleapi com/collections/123456/requests/1?api key=demo\&q=test"const axios = require('axios'); axios get('https //api redcircleapi com/collections/123456/requests/1?api key=demo\&q=test') then(response => { const apiresponse = response data; }) catch(error => { console log(error); });import requests api result = requests get('https //api redcircleapi com/collections/123456/requests/1?api key=demo\&q=test'') api response = api result json()\<?php $ch = curl init('https //api redcircleapi com/collections/123456/requests/1?api key=demo\&q=test'); curl setopt($ch, curlopt returntransfer, true); curl setopt($ch, curlopt followlocation, true); \# the following options are required if you're using an outdated openssl version \# more details https //www openssl org/blog/blog/2021/09/13/letsencryptrootcertexpire/ curl setopt($ch, curlopt ssl verifyhost, false); curl setopt($ch, curlopt ssl verifypeer, false); curl setopt($ch, curlopt timeout, 180); $json = curl exec($ch); curl close($ch); $api result = json decode($json, true); print r($api result); ?> redcircle api responds with the following json showing all the requests on page 1 of the collection { "request info" { "success" true }, "collection id" "123456", "requests page current" 1, "requests page count" 1, "requests total count" 1, "search term" "test", "requests" \[ { "type" "product", "tcin" "78025470", "custom id" "mycustomid 001", "id" "abcdefghijklmnop" } ] } finding by custom id get get /collections/collection id/requests/page?custom id=xyz in the example below we return page 1 of the requests from collection with custom id=123456 this is useful for keeping track of requests and referencing them by the id you passed into the custom id field http https //api redcircleapi com/collections/123456/requests/1?api key=demo\&custom id=mycustomid 001$ curl "https //api redcircleapi com/collections/123456/requests/1?api key=demo\&custom id=mycustomid 001" redcircle api responds with the following json showing all the requests matching the passed custom id { "request info" { "success" true }, "collection id" "123456", "requests page current" 1, "requests page count" 1, "requests total count" 1, "search term" "test", "requests" \[ { "type" "product", "tcin" "78025470", "custom id" "mycustomid 001", "id" "abcdefghijklmnop" } ] }