API Reference

Products - Search

Either search or categoryId is required.

Search the global catalog of products by text and/or category (with optional segments).
Use this to power product pickers, discovery, and faceted search.

Base URL: https://api.salescaddy.ai/api

Requirement: Provide either search or categoryId (or both).
Supports pagination via page/size.

Endpoint

POST /products/search (parameters in query string)

Query parameters

NameTypeRequiredDefaultDescription
searchstringNo*—Text query (matches name/description, etc.)
categoryIdstringNo*—Filter by product category ID
segmentarray of stringNo—Segment filter (multiple values allowed)
pageintNo0Page index (0‑based)
sizeintNo20Page size (max 200)
  • At least one of search or categoryId must be provided.

Example — Text search

curl -sS -X POST "https://api.salescaddy.ai/api/products/search?search=excel&page=0&size=20" \
  -H "Authorization: Bearer $TOKEN"
const url = "https://api.salescaddy.ai/api/products/search?search=excel&page=0&size=20";
const res = await fetch(url, { method: "POST", headers: { Authorization: `Bearer ${process.env.TOKEN}` } });
console.log(await res.json());
import os, requests
r = requests.post("https://api.salescaddy.ai/api/products/search",
                  params={"search":"crm","page":0,"size":10},
                  headers={"Authorization": f"Bearer {os.environ['TOKEN']}"})
print(r.json())
using System.Net.Http.Headers;
var http = new HttpClient();
http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", TOKEN);
var res = await http.PostAsync("https://api.salescaddy.ai/api/products/search?search=excel&page=0&size=20", null);
Console.WriteLine(await res.Content.ReadAsStringAsync());

Sample response (trimmed):

{
  "totalPages": 80,
  "totalElements": 400,
  "content": [
  {
        "id": "76f9aba2-1ff4-4a62-a2e5-0bd796091a46",
        "name": "Microsoft Excel",
        "description": "",
        "logo": "https://images.g2crowd.com/uploads/product/image/033aa224b72b00b72e8860e4e6401efc/microsoft-excel.png",
        "category": "Spreadsheets",
        "features": [
          "Addons",
          "Auto Recalculation",
          "Autosave",
          "Charts and Graphs",
          "Collaborative Editing",
          "Filtering",
          "Functions",
          "Importing and Exporting",
          "Multi Device Functionality",
          "Tables",
          "Templates"
        ],
        "reviewCount": 2792,
        "starRating": 4.699999809265137,
        "avgRating": 9.403300285339355,
        "vendor": {
          "domain": "microsoft.com",
          "name": "Microsoft",
          "logo": "https://img.logo.dev/microsoft.com?token=pk_S-z4OHSVRdqZEzd20vlKcw"
        },
        "categoryId": "d532e086-13f4-476a-b11c-e025375bcd21"
      },
      {
        "id": "490680f8a4a027e345576def7e9e5b76",
        "name": "Exceller",
        "description": "Exceller is a software solution used by Brazilian companies for managing and optimizing business processes. It provides tools for tracking customer interactions, analyzing customer data, and improving customer satisfaction.",
        "logo": "https://logo.clearbit.com/exceller.com.br",
        "category": "Other Services",
        "reviewCount": 1989,
        "starRating": 3.7448365688323975,
        "avgRating": 3.8904707431793213,
        "vendor": {
          "domain": "exceller.com.br",
          "name": "Exceller",
          "logo": "https://img.logo.dev/exceller.com.br?token=pk_S-z4OHSVRdqZEzd20vlKcw"
        },
        "categoryId": "14782e84-1662-463a-8da0-d8e1e1db0af3"
      },
      {
        "id": "ed2e9918bfa7579eb3693a1846820e1c",
        "name": "Excelify",
        "description": "Excelify is an app for Shopify that allows users to import, export, and update data in their Shopify stores using Excel files. It simplifies the process of managing product information, inventory, and other data, saving time and improving efficiency.",
        "logo": "https://logo.clearbit.com/excelify.io",
        "category": "E-Commerce Data Integration",
        "reviewCount": 1980,
        "starRating": 3.4032888412475586,
        "avgRating": 3.476439952850342,
        "vendor": {
          "domain": "excelify.io",
          "name": "Excelify",
          "logo": "https://img.logo.dev/excelify.io?token=pk_S-z4OHSVRdqZEzd20vlKcw"
        },
        "categoryId": "bb69da33-94cd-4f54-8375-d0a70b2ddbc1"
      },
    ]
}

Example — Category filter

curl -sS -X POST "https://api.salescaddy.ai/api/products/search?categoryId=cat_crm&page=0&size=10" \
  -H "Authorization: Bearer $TOKEN"
const url = "https://api.salescaddy.ai/api/products/search?categoryId=cat_crm&page=0&size=10";
const res = await fetch(url, { method: "POST", headers: { Authorization: `Bearer ${process.env.TOKEN}` } });
console.log(await res.json());
r = requests.post("https://api.salescaddy.ai/api/products/search",
                  params={"categoryId":"cat_crm","page":0,"size":10},
                  headers={"Authorization": f"Bearer {os.environ['TOKEN']}"})
print(r.json())
var res = await http.PostAsync("https://api.salescaddy.ai/api/products/search?categoryId=cat_crm&page=0&size=10", null);
Console.WriteLine(await res.Content.ReadAsStringAsync());

Example — Text + Segments

curl -sS -X POST "https://api.salescaddy.ai/api/products/search?search=analytics&segment=Mid%20Market&page=0&size=20" \
  -H "Authorization: Bearer $TOKEN"
const url = "https://api.salescaddy.ai/api/products/search?search=analytics&segment=Mid%20Market&page=0&size=20";
const res = await fetch(url, { method: "POST", headers: { Authorization: `Bearer ${process.env.TOKEN}` } });
console.log(await res.json());
r = requests.post("https://api.salescaddy.ai/api/products/search",
                  params=[("search","analytics"),("segment","mid market"),("segment","enterprise"),("page",0),("size",10)],
                  headers={"Authorization": f"Bearer {os.environ['TOKEN']}"})
print(r.json())
var url = "https://api.salescaddy.ai/api/products/search?search=analytics&segment=Mid%20Market&page=0&size=20";
var res = await http.PostAsync(url, null);
Console.WriteLine(await res.Content.ReadAsStringAsync());

Sample response (trimmed):

{
  "totalPages": 25,
  "totalElements": 245,
  "content": [
    	{
      "id": "2dbf4022-3eec-4628-a818-f00cebd0bfbf",
      "name": "Google Analytics",
      "description": "Improve the customer experience with digital analytics for your website or mobile app — for free. \n\nGoogle Analytics gives companies rich insights about their websites, their audiences and their digital marketing. Powerful, flexible and easy to use, Analytics helps savvy marketers find the messages and channels that earn them the best results. State-of-the-art conversion attribution and testing tools help companies large and small build better user experiences and maximize their digital strategy. \n\nGet user insights that only Google can give you. Understand your site and app users to better evaluate the performance of your content, products, and more. Whether your business is big or small, Google can help you see what’s working and fix what’s not. Let Google Analytics work for you. Learn more at google.com/analytics.",
      "logo": "https://images.g2crowd.com/uploads/product/image/db11aab8ccb63f5742949ab9955e36bf/google-analytics.png",
      "category": "Digital Analytics",
      "features": [
        "A/B Testing",
        "Administration Alerts",
        "API / Integrations",
        "Attribution",
        "Audience Insights",
        "Audience Targeting",
        "Buyer Personas",
        "Campaign Tracking",
        "Contact Collection",
        "Content Creation Tools",
        "Content Curation",
        "Content Management",
        "Conversions",
        "Custom Event Tracking",
        "Custom Reports and Dashboards",
        "Customizable Templated Workflows",
        "Dashboard",
        "Dashboards & Reporting",
        "Data Governance",
        "Data Normalization",
        "Data Transmission",
        "Demographics",
        "Distribution Features",
        "E-Commerce",
        "Editing and Approval Tools",
        "Engagement",
        "Entry and Exit Pages",
        "Exit Tracking",
        "Funnels",
        "Geolocation",
        "Industry Data Acquisition",
        "Integrations & APIs",
        "Internal Communication",
        "Load Time Monitoring",
        "Market Data Acquisition",
        "Mobile Reporting",
        "Performance and Reliability",
        "Promotional Messages",
        "QA Testing",
        "Real-Time Insights",
        "Real-Time Reporting",
        "Reporting and Visualization",
        "Retention",
        "Retroactive Reporting",
        "Return",
        "ROI Reporting",
        "Search Rank",
        "Segmentation",
        "SEO",
        "Sessions",
        "Sessions - Digital Analytics",
        "Site Search Reporting",
        "Social Sharing",
        "Solution Integration",
        "Source and Destination Selection",
        "Source Data Acquisition",
        "Standard Event Tracking",
        "Targeted Data Acquisition",
        "Trending",
        "Unification Across Devices",
        "User Activity History",
        "User Data",
        "User Path Tracking",
        "User Segmentation",
        "User, Role, and Access Management",
        "Version Control"
      ],
      "reviewCount": 6167,
      "starRating": 4.5,
      "avgRating": 9.03600025177002,
      "vendor": {
        "domain": "google.com",
        "name": "Google",
        "logo": "https://img.logo.dev/google.com?token=pk_S-z4OHSVRdqZEzd20vlKcw"
      },
      "categoryId": "7856f268-e41f-4f04-b5b9-3807a8224adf"
    },
    {
      "id": "7209a411-2d02-4aa3-96b2-9d8d88693e9a",
      "name": "Amplitude Analytics",
      "description": "Amplitude is a digital analytics platform designed to assist users in understanding and personalizing their digital products while optimizing the business value derived from product innovation. It serves as a comprehensive solution for organizations looking to gain insights into user behavior, feature engagement, and long-term retention strategies. By leveraging Amplitude, businesses can make informed decisions that enhance their digital product strategies and drive growth.\n\nThis platform is particularly beneficial for product, growth and marketing teams across various industries, including technology, retail, and entertainment. Amplitude's capabilities extend to real-time analytics and cross-platform tracking, making it an essential tool for teams aiming to navigate the complexities of user engagement in today's digital landscape. The platform is tailored to meet the unique needs of modern businesses, providing the tools necessary to analyze user interactions and optimize product offerings effectively.\n\nKey features of Amplitude include powerful behavioral analytics that allow users to dissect how customers interact with their products. This feature enables teams to identify which functionalities resonate most with users, thereby informing future development and marketing strategies. Additionally, Amplitude offers enterprise-level security and customer support, ensuring that organizations can trust the platform with their sensitive data while receiving assistance when needed.\n\nThe value of Amplitude is further underscored by its adoption by numerous high-profile companies, including Atlassian, Zoom, Dropbox, as well as traditional businesses undergoing digital transformation like Ford and Walmart. These organizations utilize Amplitude to not only understand their users better but also to innovate and adapt in a rapidly changing market. By providing actionable insights, Amplitude empowers teams to create more engaging and valuable digital experiences, ultimately leading to improved customer satisfaction and retention.\n\nIn essence, Amplitude stands out in the analytics category by offering a robust suite of features that cater specifically to the demands of contemporary product teams. Its focus on real-time data, user behavior analysis, and comprehensive support makes it a vital tool for any organization aiming to enhance its digital product strategy and achieve sustainable growth.",
      "logo": "https://images.g2crowd.com/uploads/product/image/d63327b58e9e55cbadb26d04e56bb0eb/amplitude-analytics.png",
      "category": "Product Analytics",
      "features": [
        "Account-Level Analytics",
        "Administration Alerts",
        "Alerts",
        "API / Integrations",
        "Attribution",
        "Campaign Tracking",
        "Conversions",
        "Custom Event Tracking",
        "Custom Reports and Dashboards",
        "Dashboard",
        "Demographics",
        "E-Commerce",
        "Engagement",
        "Entry and Exit Pages",
        "Exit Tracking",
        "Funnels",
        "Geolocation",
        "Integrations",
        "Load Time Monitoring",
        "Mobile Reporting",
        "Multi-Product Analytics",
        "Performance and Reliability",
        "Promotional Messages",
        "QA Testing",
        "Real-Time Insights",
        "Real-Time Reporting",
        "Retention",
        "Retroactive Reporting",
        "Return",
        "Segmentation",
        "Sessions - Digital Analytics",
        "Site Search Reporting",
        "Standard Event Tracking",
        "Trending",
        "Unification Across Devices",
        "User Activity History",
        "User Data",
        "User Path Tracking",
        "User Scoring",
        "User Segmentation",
        "User, Role, and Access Management",
        "User-Level Analytics"
      ],
      "reviewCount": 2201,
      "starRating": 4.5,
      "avgRating": 8.943659782409668,
      "vendor": {
        "domain": "amplitude.com",
        "name": "Amplitude",
        "logo": "https://img.logo.dev/amplitude.com?token=pk_S-z4OHSVRdqZEzd20vlKcw"
      },
      "categoryId": "ad9d5012-ea9c-4c5a-9539-365b254f5f8b"
    },
	...
  ]
}

Errors

CodeMeaningHow to fix
400Bad requestProvide search or categoryId; validate page/size and query types.
401UnauthorizedProvide/refresh Bearer token
404Not foundNo products match filters
429Rate limit exceededRetry with exponential backoff
500Internal server errorRetry later; contact support if persistent

Updated 7 months ago

Did this page help you?

Updated 7 months ago

Did this page help you?