Connections
Get connection details
Retrieves the complete configuration and status details for a specific connection by its ID within an organization. Returns all connection properties including provider settings, protocols, and current status.
get/api/v1/organizations/{organization_id}/connections/{id}
Path parameters
organization_idstring required
Organization identifier (required). Specifies which organization owns the connection you want to retrieve.
idstring required
Connection identifier (required). Specifies which specific connection to retrieve from the organization.
Response
Successfully retrieved connection details for the specified organization
Example response
{
"connection": {
"debug_enabled": true,
"domains": [
{
"name": "example.com"
}
],
"id": "conn_2123312131125533",
"mcp_server_url": "https://acmecorp.scalekit.dev/mcp/v3/connections/gmail_work",
"oauth_config": {
"access_type": "offline",
"app_name": "My Trello App",
"authorize_uri": "https://youridp.com/service/oauth/authorize",
"client_id": "oauth_client_id",
"client_secret": "oauth_client_secret",
"custom_scope_name": "user_scope",
"extensions": {
"extra_authorize_params": {
"custom_param": "value"
},
"smart": {
"aud": "https://fhir.example.com/r4",
"domain": "fhir.example.com"
}
},
"is_cimd": true,
"optional_scopes": {
"field_name": "optional_scope or bot_scope",
"scopes": [
"scope1",
"scope2"
]
},
"pkce_enabled": true,
"prompt": "none",
"redirect_uri": "https://yourapp.com/service/oauth/redirect",
"scopes": [
"openid",
"profile"
],
"sync_user_profile_on_login": true,
"tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"token_access_type": "offline",
"token_uri": "https://youridp.com/service/oauth/token",
"use_platform_creds": true,
"user_info_uri": "https://youridp.com/service/oauth/userinfo"
},
"oidc_config": {
"authorize_uri": "https://youridp.com/service/oauth/authorize",
"backchannel_logout_redirect_uri": "https://yourapp.com/sso/v1/oidc/conn_1234/backchannel-logout",
"client_id": "oauth_client_id",
"client_secret": "oauth_client_secret",
"discovery_endpoint": "https://youridp.com/service/oauth/.well-known/openid-configuration",
"idp_logout_required": true,
"issuer": "https://youridp.com/service/oauth",
"jit_provisioning_with_sso_enabled": true,
"jwks_uri": "https://youridp.com/service/oauth/jwks",
"pkce_enabled": true,
"post_logout_redirect_uri": "https://yourapp.com/sso/v1/oidc/conn_1234/logout/callback",
"redirect_uri": "https://yourapp.com/sso/v1/oidc/conn_1234/callback",
"scopes": [
"openid",
"profile"
],
"sync_user_profile_on_login": true,
"token_uri": "https://youridp.com/service/oauth/token",
"user_info_uri": "https://youridp.com/service/oauth/userinfo"
},
"organization_id": "org_2123312131125533",
"passwordless_config": {
"code_challenge_length": 6,
"enforce_same_browser_origin": true,
"frequency": 1,
"regenerate_passwordless_credentials_on_resend": true,
"validity": 600
},
"provider_key": "google",
"saml_config": {
"allow_idp_initiated_login": true,
"assertion_encrypted": true,
"certificate_id": "cer_35585423166144613",
"default_redirect_uri": "https://yourapp.com/service/saml/redirect",
"force_authn": true,
"idp_certificates": [
{
"create_time": "2021-09-01T00:00:00Z",
"expiry_time": "2021-09-01T00:00:00Z",
"id": "cert_123123123123",
"issuer": "https://youridp.com/service/saml"
}
],
"idp_entity_id": "https://youridp.com/service/saml",
"idp_metadata_url": "https://youridp.com/service/saml/metadata",
"idp_slo_required": true,
"idp_slo_url": "https://youridp.com/service/saml/slo",
"idp_sso_url": "https://youridp.com/service/saml/sso",
"jit_provisioning_with_sso_enabled": true,
"sp_assertion_url": "https://youridp.com/service/saml/assertion",
"sp_entity_id": "https://yourapp.com/service/saml",
"sp_metadata_url": "https://youridp.com/service/saml/metadata",
"sp_slo_url": "https://yourapp.com/sso/v1/saml/conn_1234/slo/callback",
"sync_user_profile_on_login": true,
"ui_button_title": "Login with SSO",
"want_request_signed": true
},
"test_connection_uri": "https://auth.example.com/test-connection/conn_2123312131125533"
}
}