Console API

OAuth connections

4 endpoints.

GET/api/v1/admin/businesses/{business_id}/connections

List active OAuth connections for a business

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_OAuthConnectionsListData_

Field Type Description

request_idrequired string

success true default true

datarequired

OAuthConnectionsListData

OAuthConnectionsListData fields

Field	Type	Description
`connections`required	`OAuthConnectionData[]`	OAuthConnectionData[] fields OAuthConnectionData (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}/connections/{connection_id}

Disconnect an OAuth connection

Parameters

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

Responses

204Successful Response

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}/connections/oauth/{provider}/start

Start OAuth for an authority (e.g. Google)

Return an authorization URL for the given OAuth authority (admin UI redirect).

Parameters

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

Request bodyrequired

application/jsonOAuthStartBody

Field	Type	Description
`redirect_uri`	`string \| null`	Optional redirect URI; must match a Google-authorized callback when using Google.

Responses

200Successful Response

application/jsonSuccessResponse_OAuthStartResponseData_

Field Type Description

request_idrequired string

success true default true

datarequired

OAuthStartResponseData

OAuthStartResponseData fields

Field	Type	Description
`authorization_url`required	`string`
`state`required	`string`
`connection_id`	`string (uuid) \| null`	Present when exactly one active connection exists for this business and provider.

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/connections/oauth/{provider}/callback

OAuth callback (browser redirect target)

Exchange authorization code for tokens and upsert ``oauth_connections`` (no JWT: IDP redirect).

Parameters

Name	In	Type
`provider`required	path	`OAuthProvider`
`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.