Console API

Listing reviews

6 endpoints.

GET/api/v1/admin/businesses/{business_id}/listing-reviews

List listing reviews (optionally scoped to one listing)

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`listing_id`	query	`string (uuid) \| null`	When set, only reviews for this listing id.
`limit`	query	`integer`	default 20
`cursor`	query	`string \| null`
`sort_by`	query	`string`	default "updated_desc"
`rating_min`	query	`integer \| null`
`rating_max`	query	`integer \| null`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_ListingReviewData__

Field Type Description

request_idrequired string

success true default true

datarequired

ListingReviewData[]

ListingReviewData[] fields

Field	Type	Description
`id`required	`string (uuid)`
`business_id`required	`string (uuid)`
`provider`required	`ListingProvider`
`listing_id`required	`string (uuid)`
`provider_review_id`required	`string`
`provider_resource_name`required	`string`
`reviewer_display_name`required	`string \| null`
`reviewer_profile_photo_url`required	`string \| null`
`reviewer_is_anonymous`required	`boolean`
`rating`required	`integer \| null`
`body`required	`string \| null`
`language`required	`string \| null`
`permalink_url`required	`string \| null`
`provider_created_at`required	`string (date-time) \| null`
`provider_updated_at`required	`string (date-time) \| null`
`status`required	`ListingReviewStatus`
`review_metadata`required	`object \| null`
`is_featured`	`boolean`	default false
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`

metadata

ResponseMetadata | null

ResponseMetadata fields

Field Type Description

pagination

PaginationMetadata | null

PaginationMetadata fields

Field	Type	Description
`limit`required	`integer`
`next_cursor`	`string \| null`
`prev_cursor`	`string \| null`
`has_more`required	`boolean`
`has_prev`	`boolean`	default false
`total_count`	`integer \| null`

status_counts

object | null

object | null fields

Map of string to integer

lifecycle_counts

LifecycleCounts | null

LifecycleCounts fields

Field	Type	Description
`lead`	`integer`	default 0
`prospect`	`integer`	default 0
`customer`	`integer`	default 0
`former_customer`	`integer`	default 0

classification_counts

ClassificationCounts | null

ClassificationCounts fields

Field	Type	Description
`signal`	`object`	object fields Nested object (not expanded)
`touch`	`object`	object fields Nested object (not expanded)
`stage`	`object`	object fields Nested object (not expanded)

meta

ResponseMeta | null

ResponseMeta fields

Field	Type	Description
`total`	`integer \| null`
`total_count`	`integer \| null`
`page`	`integer \| null`
`per_page`	`integer \| null`

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/listing-reviews/{review_id}

Get one listing review

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`review_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_ListingReviewData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`ListingReviewData`	ListingReviewData fields ListingReviewData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

PATCH/api/v1/admin/businesses/{business_id}/listing-reviews/{review_id}

Update listing review (e.g. featured flag)

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`review_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonListingReviewFeaturedUpdateBody

Field	Type	Description
`is_featured`required	`boolean`

Responses

200Successful Response

application/jsonSuccessResponse_ListingReviewData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`ListingReviewData`	ListingReviewData fields ListingReviewData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/listing-reviews/{review_id}/replies

List replies for a listing review

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`review_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_ListingReviewReplyData__

Field Type Description

request_idrequired string

success true default true

datarequired

ListingReviewReplyData[]

ListingReviewReplyData[] fields

Field	Type	Description
`id`required	`string (uuid)`
`business_id`required	`string (uuid)`
`listing_review_id`required	`string (uuid)`
`provider`required	`ListingProvider`
`provider_reply_id`	`string \| null`
`parent_reply_id`	`string (uuid) \| null`
`thread_root_reply_id`	`string (uuid) \| null`
`author_type`required	`ListingReplyAuthorType`
`provider_author_id`	`string \| null`
`body`	`string \| null`
`provider_created_at`	`string (date-time) \| null`
`provider_updated_at`	`string (date-time) \| null`
`is_deleted`required	`boolean`
`reply_metadata`	`object \| null`
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

PUT/api/v1/admin/businesses/{business_id}/listing-reviews/{review_id}/reply

Create or update owner reply for a listing review

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`review_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonListingReviewReplyUpsertBody

Field	Type	Description
`comment`required	`string`

Responses

200Successful Response

application/jsonSuccessResponse_ListingReviewReplyData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`ListingReviewReplyData`	ListingReviewReplyData fields ListingReviewReplyData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

DELETE/api/v1/admin/businesses/{business_id}/listing-reviews/{review_id}/reply

Delete owner reply for a listing review

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`review_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

204Successful Response

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.