Public API

Reviews

2 endpoints.

GET/api/v1/public/reviews

List reviews

List public reviews for the business (legacy-compatible, non-paginated).

Parameters

Name	In	Type	Description
`X-API-Key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_PublicReview__

Field Type Description

request_idrequired string

success true default true

datarequired

PublicReview[]

PublicReview[] fields

Field	Type	Description
`id`required	`string`
`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`	`string \| null`
`created_at`	`string \| null`
`updated_at`	`string \| null`
`photo_attachments`	`PublicPhotoAttachment[]`	PublicPhotoAttachment[] fields Nested object (not expanded)

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

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/public/reviews/featured

List featured reviews

List featured public reviews for the business (legacy-compatible, non-paginated).

Parameters

Name	In	Type	Description
`X-API-Key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_PublicReview__

Field Type Description

request_idrequired string

success true default true

datarequired

PublicReview[]

PublicReview[] fields

PublicReview, expanded above.

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

ResponseMeta, expanded above.

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

Error bodies: ErrorResponse. See Errors.