Skip to main content
POST
/
api
/
capterra
/
products
/
search
/capterra/products/search
curl --request POST \
  --url https://api.anysite.io/api/capterra/products/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "query": "<string>",
  "count": 10,
  "timeout": 300
}
'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "seo_id": "<string>",
    "alias": "<string>",
    "name": "<string>",
    "url": "<string>",
    "position": 123,
    "@type": "CapterraSearchProduct",
    "image": "<string>",
    "short_description": "<string>",
    "rating": 123,
    "review_count": 0
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
query
string
required
Minimum string length: 1
​
count
integer
required
Required range: 1 <= x <= 20
​
timeout
integer
default:300
Required range: 20 <= x <= 1500

Response

Successful Response

​
id
string<uuid>
required
​
seo_id
string
required
​
alias
string
required
​
name
string
required
​
url
string
required
​
position
integer
required
​
@type
string
default:CapterraSearchProduct
​
image
string | null
​
short_description
string | null
​
rating
number | null
​
review_count
integer
default:0