Skip to main content
POST
/capterra/products

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
product
string
required
Minimum string length: 1
Pattern: ^(?:https?://[^\s]+|//[^\s]+|(?:www\.|capterra\.com)[^\s]*|\d+(?:/[^\s/?#]+)?)$
timeout
integer
default:300
Required range: 20 <= x <= 1500

Response

Successful Response

id
string<uuid>
required
seo_id
string
required
@type
string
default:CapterraProduct
alias
string | null
name
string | null
short_description
string | null
vendor_name
string | null
image
string | null
website_url
string | null
pricing_starting_from
string | null
pricing_unit
string | null
pricing_currency
string | null
pricing_model
string | null
payment_frequency
string | null
has_free_trial
boolean | null
has_free_version
boolean | null
rating
number | null
review_count
integer | null
ease_of_use_rating
number | null
customer_support_rating
number | null
value_for_money_rating
number | null
functionality_rating
number | null
last_updated
string | null
review_sentiment
object | null
review_distribution
object | null
review_topics
object[]
pros
object[]
cons
object[]
categories
object[]
features
object[]
screenshots
string[]
videos
string[]
awards
string[]
alternatives
object[]
integrations
object[]
comparisons
object[]
shortlist_badges
object[]
deployment
string[]
training
string[]
support
string[]
target_company_sizes
string[]
url
string | null