Keystone Developers
Open Keystone
API reference

Console API

Integrations status

1 endpoint.

GET/api/v1/admin/businesses/{business_id}/integrations/status

Combined status for every integration on the console's rail

All eight rail rows in one payload, always complete and in rail order.

Rows report ``unknown``/``not_configured`` where the signal is missing — never a fabricated ``connected``. The two OAuth-backed rows (Meta, Google Business Profile) separate "authenticated" from "actually usable" and put the blocking reason in ``detail``, so an unaccepted GBP location-manager invite reads as ``pending`` with the reason rather than as a green tick.

Parameters

NameInTypeDescription
business_idrequiredpathstring (uuid)
authorizationheaderstring | null

Responses

200Successful Response
application/jsonSuccessResponse_IntegrationsStatusData_
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredIntegrationsStatusData
IntegrationsStatusData fields
FieldTypeDescription
business_idrequiredstring (uuid)
website_idstring (uuid) | null
rowsrequiredIntegrationStatusRow[]
IntegrationStatusRow[] fields

IntegrationStatusRow (not expanded)

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.