Console API

Reviews

5 endpoints.

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

List reviews

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`limit`	query	`integer`	default 20
`cursor`	query	`string \| null`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_AdminReview__

Field Type Description

request_idrequired string

success true default true

datarequired

AdminReview[]

AdminReview[] fields

Field	Type	Description
`id`required	`string`
`business_id`required	`string`
`location_id`	`string \| null`
`reviewer_name`required	`string`
`reviewer_title`	`string \| null`
`company`	`string \| null`
`rating`required	`integer`
`content_markdown`	`string \| null`
`source`	`string \| null`
`source_url`	`string \| null`
`featured`	`boolean`	default false
`reviewed_at`required	`string (date-time)`
`photos`	`PhotoData[]`	PhotoData[] fields Nested object (not expanded)
`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.

POST/api/v1/admin/businesses/{business_id}/reviews

Create review

Parameters

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

Request bodyrequired

application/jsonAdminReviewCreate

Field	Type	Description
`reviewer_name`required	`string`
`reviewer_title`	`string \| null`
`company`	`string \| null`
`rating`required	`integer`	min 1 · max 5
`content_markdown`	`string \| null`
`source`required	`string`
`source_url`	`string \| null`
`featured`	`boolean`	default false
`reviewed_at`required	`string (date-time)`
`location_id`	`string \| null`
`photo_ids`	`string[]`	max items 5 string[] fields

Responses

201Successful Response

application/jsonSuccessResponse_AdminReview_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`AdminReview`	AdminReview fields AdminReview, 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}/reviews/{review_id}

Get review details

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_AdminReview_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`AdminReview`	AdminReview fields AdminReview, 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.

PUT/api/v1/admin/businesses/{business_id}/reviews/{review_id}

Update review

Parameters

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

Request bodyrequired

application/jsonAdminReviewUpdate

Field	Type	Description
`reviewer_name`	`string \| null`
`reviewer_title`	`string \| null`
`company`	`string \| null`
`rating`	`integer \| null`
`content_markdown`	`string \| null`
`source`	`string \| null`
`source_url`	`string \| null`
`featured`	`boolean \| null`
`reviewed_at`	`string (date-time) \| null`
`location_id`	`string \| null`
`photo_ids`	`string[] \| null`	string[] \| null fields

Responses

200Successful Response

application/jsonSuccessResponse_AdminReview_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`AdminReview`	AdminReview fields AdminReview, 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}/reviews/{review_id}

Delete 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.