Keystone Developers
Open Keystone
API reference

Console API

Listings agent

2 endpoints.

GET/api/v1/businesses/{business_id}/listings-agent/config

Get effective listings-agent settings for a business

Parameters

NameInTypeDescription
business_idrequiredpathstring (uuid)
authorizationheaderstring | null

Responses

200Successful Response
application/jsonSuccessResponse_SimpleAgentConfigData_
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredSimpleAgentConfigData
SimpleAgentConfigData fields
FieldTypeDescription
business_idrequiredstring
enabledrequiredboolean
instructionsstringdefault ""
versioninteger | null
updated_atstring (date-time) | null
metadataResponseMetadata | null
ResponseMetadata fields
FieldTypeDescription
paginationPaginationMetadata | null
PaginationMetadata fields
FieldTypeDescription
limitrequiredinteger
next_cursorstring | null
prev_cursorstring | null
has_morerequiredboolean
has_prevbooleandefault false
total_countinteger | null
status_countsobject | null
object | null fields

Map of string to integer

lifecycle_countsLifecycleCounts | null
LifecycleCounts fields
FieldTypeDescription
leadintegerdefault 0
prospectintegerdefault 0
customerintegerdefault 0
former_customerintegerdefault 0
classification_countsClassificationCounts | null
ClassificationCounts fields
FieldTypeDescription
signalobject
object fields

Nested object (not expanded)

touchobject
object fields

Nested object (not expanded)

stageobject
object fields

Nested object (not expanded)

metaResponseMeta | null
ResponseMeta fields
FieldTypeDescription
totalinteger | null
total_countinteger | null
pageinteger | null
per_pageinteger | null
  • 400Bad request
  • 401Unauthorized
  • 403Forbidden
  • 404Not found
  • 422Validation error
  • 500Internal server error
  • 503Service unavailable

Error bodies: ErrorResponse. See Errors.

PATCH/api/v1/businesses/{business_id}/listings-agent/config

Update listings-agent settings for a business

Parameters

NameInTypeDescription
business_idrequiredpathstring (uuid)
authorizationheaderstring | null

Request bodyrequired

application/jsonSimpleAgentConfigPatchBody
FieldTypeDescription
enabledboolean | null
instructionsstring | null

Responses

200Successful Response
application/jsonSuccessResponse_SimpleAgentConfigData_
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredSimpleAgentConfigData
SimpleAgentConfigData fields

SimpleAgentConfigData, expanded above.

metadataResponseMetadata | null
ResponseMetadata fields

ResponseMetadata, expanded above.

metaResponseMeta | null
ResponseMeta fields

ResponseMeta, expanded above.

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

Error bodies: ErrorResponse. See Errors.