Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

property_id
string

Agoda numeric property ID

Minimum string length: 1
url
string<uri>

Full Agoda property URL

city_id
string

Agoda numeric city ID, required alongside property_id when url is not given (see GET /v1/agoda/search's resolved_city_id)

Pattern: ^\d+$
page
string

Review page number (default 1)

Pattern: ^\d+$
sort_by
string

Review sort order

Minimum string length: 1
language
string

Review language filter (ISO 2-letter code)

Pattern: ^[A-Za-z]{2}$
timeout_ms
string

Max time to wait, in ms

Pattern: ^\d+$

Response

Agoda review score breakdown and review cards.

provider
enum<string>
required
Available options:
agoda
page_type
enum<string>
required
Available options:
reviews
snapshot_at
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
property_id
string | null
required
name
string | null
required
review_score
number | null
required
review_count
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
meta_data
object
required
score_breakdown
object
required
reviews
object[]
required