Console API

Listing accounts

6 endpoints.

POST/api/v1/admin/businesses/{business_id}/listings/{listing_id}/keystone-invite/retry

Retry accepting the Keystone location-manager invite for a listing

Fire the durable accept worker for a listing whose Keystone manager invite is stuck 'pending'. Idempotent and non-blocking — the worker retries acceptance off-request.

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_dict_

Field Type Description

request_idrequired string

success true default true

datarequired object

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.

PATCH/api/v1/admin/businesses/{business_id}/listings/{listing_id}/mapping

Map or unmap a listing to an internal SOR location

Parameters

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

Request bodyrequired

application/jsonListingInternalMappingBody

Field	Type	Description
`internal_location_id`	`string (uuid) \| null`

Responses

200Successful Response

application/jsonSuccessResponse_ListingLocationData_

Field Type Description

request_idrequired string

success true default true

datarequired

ListingLocationData

ListingLocationData fields

Field	Type	Description
`id`required	`string (uuid)`
`business_id`required	`string (uuid)`
`listing_account_id`required	`string (uuid)`
`provider`required	`ListingProvider`
`provider_listing_id`required	`string`
`provider_resource_name`required	`string`
`internal_location_id`	`string (uuid) \| null`
`title`	`string \| null`
`store_code`	`string \| null`
`location_metadata`	`object \| null`
`overview`	`object \| null`
`synced_at`	`string (date-time) \| null`
`is_managed`required	`boolean`
`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.

GET/api/v1/admin/businesses/{business_id}/listings/accounts

List listing provider accounts

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_list_ListingAccountData__

Field Type Description

request_idrequired string

success true default true

datarequired

ListingAccountData[]

ListingAccountData[] fields

Field	Type	Description
`id`required	`string (uuid)`
`business_id`required	`string (uuid)`
`connection_id`required	`string (uuid)`
`provider`required	`ListingProvider`
`provider_account_id`required	`string`
`provider_account_name`	`string \| null`
`account_metadata`	`object`
`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.

POST/api/v1/admin/businesses/{business_id}/listings/discovery/import

Discover and import provider accounts + listings for a business

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`connection_id`required	query	`string (uuid)`	OAuth connection used to call the provider API.
`provider`	query	`ListingProvider`	default "gbp"
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_ListingDiscoveryImportResponseData_

Field Type Description

request_idrequired string

success true default true

datarequired

ListingDiscoveryImportResponseData

ListingDiscoveryImportResponseData fields

Field	Type	Description
`accounts_discovered`required	`integer`
`locations_discovered`required	`integer`
`locations_created_or_updated`required	`integer`

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}/listings/locations

List provider listing locations for this business

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`provider`	query	`ListingProvider \| null`
`is_managed`	query	`boolean \| null`
`internal_location_id`	query	`string (uuid) \| null`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_ListingLocationData__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`ListingLocationData[]`	ListingLocationData[] fields ListingLocationData, 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}/listings/selection

Replace which listings are managed for this business

Parameters

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

Request bodyrequired

application/jsonManagedListingSelectionBody

Field	Type	Description
`managed_listing_ids`required	`string (uuid)[]`	string (uuid)[] fields
`auto_accept_keystone_invitations`	`boolean`	GBP: after inviting Keystone as location manager, poll and accept the pending invitation using Keystone agency OAuth (KEYSTONE_GBP_OAUTH_*). Set false to leave the invite pending for manual acceptance. default true

Responses

200Successful Response

application/jsonSuccessResponse_ManagedListingSelectionResponseData_

Field Type Description

request_idrequired string

success true default true

datarequired

ManagedListingSelectionResponseData

ManagedListingSelectionResponseData fields

Field	Type	Description
`listings`required	`ListingLocationData[]`	ListingLocationData[] fields ListingLocationData (not expanded)
`accept_invite_success`required	`boolean`	When ``auto_accept_keystone_invitations`` was true: false if any accept attempt failed (API error or no matching invite after retries). True when auto-accept was false or every newly managed listing accepted successfully.
`configure_notification_success`required	`boolean`	False if any ``enable_notifications`` (after newly managed) or ``disable_notifications`` (after last unmanaged on an account) raised; errors are logged only.

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.