Console API

Social integrations

11 endpoints.

GET/api/v1/admin/businesses/{business_id}/social_integrations/meta

Get Meta social integration status

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_SocialIntegrationStatusData_

Field Type Description

request_idrequired string

success true default true

datarequired

SocialIntegrationStatusData

SocialIntegrationStatusData fields

Field	Type	Description
`business_id`required	`string`
`provider`	`string`	default "meta"
`preferred_channel`	`string`	default "agency_business"
`status`required	`string`
`channels`	`SocialIntegrationChannelData[]`	default [] SocialIntegrationChannelData[] fields SocialIntegrationChannelData (not expanded)

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.

DELETE/api/v1/admin/businesses/{business_id}/social_integrations/meta

Disconnect Meta social integration

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_SocialIntegrationData_

Field Type Description

request_idrequired string

success true default true

datarequired

SocialIntegrationData

SocialIntegrationData fields

Field	Type	Description
`id`	`string \| null`
`business_id`required	`string`
`provider`	`string`	default "meta"
`status`required	`string`
`scopes`	`string[]`	default [] string[] fields
`external_user_id`	`string \| null`
`external_user_name`	`string \| null`
`last_synced_at`	`integer \| null`
`last_error_code`	`string \| null`
`last_error_message`	`string \| null`
`created_at`	`integer \| null`
`updated_at`	`integer \| null`

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}/social_integrations/meta/agency

Get Keystone agency Meta connection readiness

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_SocialAgencyConnectionData_

Field Type Description

request_idrequired string

success true default true

datarequired

SocialAgencyConnectionData

SocialAgencyConnectionData fields

Field	Type	Description
`provider`	`string`	default "meta"
`agency_business_id`	`string \| null`
`status`required	`string`
`connected`	`boolean`	default false
`business_onboarding_completed`	`boolean`	default false
`business_profiles_publishable`	`boolean`	default false
`publish_blocking_reason`	`string \| null`
`last_validated_at`	`integer \| null`
`last_error_code`	`string \| null`
`last_error_message`	`string \| null`

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}/social_integrations/meta/agency/validate

Validate Keystone agency Meta connection

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_SocialAgencyConnectionData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`SocialAgencyConnectionData`	SocialAgencyConnectionData fields SocialAgencyConnectionData, 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}/social_integrations/meta/connect_url

Get Meta OAuth connection URL

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_MetaConnectUrlData_

Field Type Description

request_idrequired string

success true default true

datarequired

MetaConnectUrlData

MetaConnectUrlData fields

Field	Type	Description
`connect_url`required	`string`
`expires_at`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}/social_integrations/meta/instagram_direct/connect_url

Get Instagram direct OAuth connection URL

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_MetaConnectUrlData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`MetaConnectUrlData`	MetaConnectUrlData fields MetaConnectUrlData, 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}/social_integrations/meta/instagram_direct/oauth/callback

Complete Instagram direct OAuth callback

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`code`	query	`string \| null`
`state`	query	`string \| null`
`error`	query	`string \| null`
`error_description`	query	`string \| null`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonany

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}/social_integrations/meta/oauth/callback

Complete Meta OAuth callback

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`code`	query	`string \| null`
`state`	query	`string \| null`
`error`	query	`string \| null`
`error_description`	query	`string \| null`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonany

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}/social_integrations/meta/sync_profiles

Sync Meta Facebook and Instagram profiles

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`connection_channel`	query	`string`	all\|agency_business\|instagram_direct default "all"
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_MetaProfileSyncData_

Field Type Description

request_idrequired string

success true default true

datarequired

MetaProfileSyncData

MetaProfileSyncData fields

Field	Type	Description
`connection`required	`SocialIntegrationData`	SocialIntegrationData fields SocialIntegrationData, expanded above.
`profiles_synced`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/social_integrations/meta/instagram_direct/oauth/callback

Complete Instagram direct OAuth callback

Parameters

Name	In	Type
`code`	query	`string \| null`
`state`	query	`string \| null`
`error`	query	`string \| null`
`error_description`	query	`string \| null`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonany

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

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/social_integrations/meta/oauth/callback

Complete Meta OAuth callback

Parameters

Name	In	Type
`code`	query	`string \| null`
`state`	query	`string \| null`
`error`	query	`string \| null`
`error_description`	query	`string \| null`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonany

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

Error bodies: ErrorResponse. See Errors.