Resource slugs turned off for this connection — by the setup wizard, the filters dialog, or connect-time credential verification. Excluded from status displays but still configurable (re-enableable).
Resource slug this connection is bound to, when it was connected as a single source (Gmail rather than Google). Such a connection carries exactly that resource; null for provider-wide connections.
MCP tools this connection can vend, with whether each is enabled and whether the connection's OAuth grant covers it. Empty when the workspace is not entitled to connection tools.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Adapter","colors":{"primary":"#8765F0","light":"#8765F0","dark":"#8765F0"},"logo":{"light":"https://mintcdn.com/adapter/J3Ydy4fSe61BUDTE/logo/light.svg?fit=max\u0026auto=format\u0026n=J3Ydy4fSe61BUDTE\u0026q=85\u0026s=459bd6410eb825d264414176cd7eba07","dark":"https://mintcdn.com/adapter/J3Ydy4fSe61BUDTE/logo/dark.svg?fit=max\u0026auto=format\u0026n=J3Ydy4fSe61BUDTE\u0026q=85\u0026s=0bed0f3d3311b99106ba98e43a63d5e2"},"favicon":"https://mintcdn.com/adapter/J3Ydy4fSe61BUDTE/favicon.svg?fit=max\u0026auto=format\u0026n=J3Ydy4fSe61BUDTE\u0026q=85\u0026s=83406b22c16edb6994e5b28b146a7446","api":{"openapi":"api-reference/openapi.json","playground":{}},"background":{"color":{"light":"#F2F2F0","dark":"#171717"}},"navbar":{"links":[{"href":"mailto:support@adapter.com","label":"Support"}],"primary":{"type":"button","label":"Sign In","href":"https://mind.adapter.com"}},"footer":{"socials":{"x":"https://x.com/adapter"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"adapter","hasAudioNarration":false,"actualSubdomain":"adapter","customDomains":["docs.beta.adapter.com"],"gitSource":{"type":"github","owner":"adapter-group","repo":"adapter-platform","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae23bb95db1d64f77da812c","collectionId":"3e863929-e534-43f8-bffd-cc13d5f5a900","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae23bb95db1d64f77da812c"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae23bb95db1d64f77da812c","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":40},{"language":"default","tag":"Documentation","count":13},{"language":"default","tag":"Knowledge","count":11},{"language":"default","tag":"Triggers","count":10},{"language":"default","tag":"Core Concepts","count":7},{"language":"default","tag":"Ingestion","count":6},{"language":"default","tag":"Custom Connectors","count":5},{"language":"default","tag":"Getting Started","count":4},{"language":"default","tag":"Connectors","count":3},{"language":"default","tag":"Data","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/connectors/get-connection","slug":"/api-reference/connectors/get-connection","pageMetadata":{"title":"Get Connection","openapi":"GET /v1/connections/{connection_id}","description":"Returns a connection by ID.","href":"/api-reference/connectors/get-connection"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns a connection by ID.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Connection","openapi":"GET /v1/connections/{connection_id}","description":"Returns a connection by ID.","href":"/api-reference/connectors/get-connection"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["connectors"],"summary":"Get Connection","description":"Returns a connection by ID.","operationId":"get_connection","parameters":["63a419c0-7baf-41e9-ad0e-c2edb4e65d4b"],"responses":{"200":"edf4e44a-35e6-4dea-ab48-52aa019e705d","401":"3f504489-9787-4713-9be8-562a5d356a5b","403":"4a24763a-cef5-4394-891f-946dfc3f8c42","404":"5685f3e4-8814-4040-bd84-7f382e3c4205","422":"60549302-c776-490c-a169-e975494429fb","500":"bed777bd-7a6c-4a99-86a0-f4d465f51897"},"method":"get","type":"path","servers":["b45a6dfc-eec4-42ae-a72a-9361a1098054"],"security":[],"path":"/v1/connections/{connection_id}","baseUrlOptions":["http://localhost:8080"],"title":"Get Connection","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"63a419c0-7baf-41e9-ad0e-c2edb4e65d4b":{"name":"connection_id","in":"path","required":true,"schema":{"type":"string","title":"Connection Id","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"edf4e44a-35e6-4dea-ab48-52aa019e705d":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"connection_id":{"type":"string","title":"Connection Id","description":"Unique identifier for the connection.","examples":["conn_01abc123"],"isRequired":true,"uniqueKey":"connection_id","typeLabel":"string"},"provider":{"type":"string","title":"Provider","description":"Provider slug.","examples":["slack"],"isRequired":true,"uniqueKey":"provider","typeLabel":"string"},"resources":{"items":{"type":"string","uniqueKey":"resources.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Resources","description":"Resource slugs enabled for this connection.","examples":[["messages","files"]],"isRequired":true,"uniqueKey":"resources","typeLabel":"string[]"},"connected_at":{"oneOf":[{"type":"string","title":"Connected At","description":"ISO 8601 timestamp of when the connection was created.","example":"2026-01-15T10:30:00Z","uniqueKey":"connected_at.oneOf.0","typeLabel":"string"},{"type":"null","title":"Connected At","description":"ISO 8601 timestamp of when the connection was created.","example":"2026-01-15T10:30:00Z","uniqueKey":"connected_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"connected_at","typeLabel":"string | null"},"team_name":{"oneOf":[{"type":"string","title":"Team Name","description":"Workspace or team display name from the provider.","example":"Acme Corp","uniqueKey":"team_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Team Name","description":"Workspace or team display name from the provider.","example":"Acme Corp","uniqueKey":"team_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"team_name","typeLabel":"string | null"},"external_account_id":{"oneOf":[{"type":"string","title":"External Account Id","description":"Account ID assigned by the provider.","example":"T01ABC123","uniqueKey":"external_account_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Account Id","description":"Account ID assigned by the provider.","example":"T01ABC123","uniqueKey":"external_account_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_account_id","typeLabel":"string | null"},"disabled_resources":{"items":{"type":"string","uniqueKey":"disabled_resources.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Disabled Resources","description":"Resource slugs turned off for this connection — by the setup wizard, the filters dialog, or connect-time credential verification. Excluded from status displays but still configurable (re-enableable).","examples":[["email"]],"uniqueKey":"disabled_resources","typeLabel":"string[]"},"source":{"oneOf":[{"type":"string","title":"Source","description":"Resource slug this connection is bound to, when it was connected as a single source (Gmail rather than Google). Such a connection carries exactly that resource; null for provider-wide connections.","example":"email","uniqueKey":"source.oneOf.0","typeLabel":"string"},{"type":"null","title":"Source","description":"Resource slug this connection is bound to, when it was connected as a single source (Gmail rather than Google). Such a connection carries exactly that resource; null for provider-wide connections.","example":"email","uniqueKey":"source.oneOf.1","typeLabel":"null"}],"uniqueKey":"source","typeLabel":"string | null"},"name":{"type":"string","title":"Name","description":"Display name for the connection's source or provider.","default":"","examples":["Gmail"],"uniqueKey":"name","typeLabel":"string"},"icon":{"type":"string","title":"Icon","description":"Icon key for the source (falls back to the provider slug).","default":"","examples":["gmail"],"uniqueKey":"icon","typeLabel":"string"},"tools":{"items":{"properties":{"name":{"type":"string","title":"Name","description":"MCP tool name.","examples":["google_calendar_create_event"],"isRequired":true,"uniqueKey":"tools.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","title":"Description","description":"What the tool does, as shown to the agent.","default":"","uniqueKey":"tools.items.[INDEX].description","typeLabel":"string"},"writes":{"type":"boolean","title":"Writes","description":"True if the tool changes data at the provider.","default":false,"uniqueKey":"tools.items.[INDEX].writes","typeLabel":"boolean"},"scopes":{"items":{"type":"string","uniqueKey":"tools.items.[INDEX].scopes.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Scopes","description":"Provider OAuth scopes the connection's grant must cover for this tool to be offered.","uniqueKey":"tools.items.[INDEX].scopes","typeLabel":"string[]"},"enabled":{"type":"boolean","title":"Enabled","description":"True if the user enabled this tool on the connection.","default":false,"uniqueKey":"tools.items.[INDEX].enabled","typeLabel":"boolean"},"granted":{"type":"boolean","title":"Granted","description":"True if the connection's OAuth grant covers the tool's scopes. A tool that is not granted cannot be enabled until the connection is re-authorized.","default":false,"uniqueKey":"tools.items.[INDEX].granted","typeLabel":"boolean"}},"type":"object","required":["name"],"title":"ConnectionToolOut","uniqueKey":"tools.items.[INDEX]","typeLabel":"ConnectionToolOut · object"},"type":"array","title":"Tools","description":"MCP tools this connection can vend, with whether each is enabled and whether the connection's OAuth grant covers it. Empty when the workspace is not entitled to connection tools.","uniqueKey":"tools","typeLabel":"ConnectionToolOut · object[]"}},"type":"object","required":["connection_id","provider","resources"],"title":"ConnectionOut","uniqueKey":"","typeLabel":"ConnectionOut · object"},"examples":{"Example":{"title":"Example","value":{"connection_id":"conn_01abc123","provider":"slack","resources":["messages","files"],"connected_at":"2026-01-15T10:30:00Z","team_name":"Acme Corp","external_account_id":"T01ABC123","disabled_resources":["email"],"source":"email","name":"Gmail","icon":"gmail","tools":[{"name":"google_calendar_create_event","description":"","writes":false,"scopes":["\u003cstring>"],"enabled":false,"granted":false}]}}},"exampleType":"generated"}},"exampleType":"generated"},"3f504489-9787-4713-9be8-562a5d356a5b":{"content":{"application/json":{"schema":{"properties":{"error_code":{"type":"string","const":"authentication_error","title":"Error Code","default":"authentication_error","uniqueKey":"error_code","typeLabel":"string"},"message":{"type":"string","title":"Message","default":"Invalid or missing credentials.","uniqueKey":"message","typeLabel":"string"},"details":{"oneOf":[{"type":"object","title":"Details","additionalProperties":true,"uniqueKey":"details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object | null"}},"type":"object","title":"AuthenticationErrorModel","uniqueKey":"","typeLabel":"AuthenticationErrorModel · object"},"examples":{"Example":{"title":"Example","value":{"error_code":"authentication_error","message":"Invalid or missing credentials.","details":{}}}},"exampleType":"generated"}},"description":"Unauthorized","exampleType":"generated"},"4a24763a-cef5-4394-891f-946dfc3f8c42":{"content":{"application/json":{"schema":{"properties":{"error_code":{"type":"string","const":"permission_denied","title":"Error Code","default":"permission_denied","uniqueKey":"error_code","typeLabel":"string"},"message":{"type":"string","title":"Message","default":"You do not have permission to perform this action.","uniqueKey":"message","typeLabel":"string"},"details":{"oneOf":[{"type":"object","title":"Details","additionalProperties":true,"uniqueKey":"details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object | null"}},"type":"object","title":"PermissionDeniedErrorModel","uniqueKey":"","typeLabel":"PermissionDeniedErrorModel · object"},"examples":{"Example":{"title":"Example","value":{"error_code":"permission_denied","message":"You do not have permission to perform this action.","details":{}}}},"exampleType":"generated"}},"description":"Forbidden","exampleType":"generated"},"5685f3e4-8814-4040-bd84-7f382e3c4205":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error_code":{"type":"string","const":"connection_not_found","title":"Error Code","default":"connection_not_found","uniqueKey":"error_code","typeLabel":"string"},"details":{"oneOf":[{"type":"object","title":"Details","additionalProperties":true,"uniqueKey":"details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object | null"}},"type":"object","required":["message"],"title":"ConnectionNotFoundErrorModel","uniqueKey":"","typeLabel":"ConnectionNotFoundErrorModel · object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error_code":"connection_not_found","details":{}}}},"exampleType":"generated"}},"description":"Not Found","exampleType":"generated"},"60549302-c776-490c-a169-e975494429fb":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"bed777bd-7a6c-4a99-86a0-f4d465f51897":{"content":{"application/json":{"schema":{"properties":{"error_code":{"type":"string","const":"internal_server_error","title":"Error Code","default":"internal_server_error","uniqueKey":"error_code","typeLabel":"string"},"message":{"type":"string","title":"Message","default":"An unexpected error occurred.","uniqueKey":"message","typeLabel":"string"},"details":{"oneOf":[{"type":"object","title":"Details","additionalProperties":true,"uniqueKey":"details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object | null"}},"type":"object","title":"InternalServerErrorModel","uniqueKey":"","typeLabel":"InternalServerErrorModel · object"},"examples":{"Example":{"title":"Example","value":{"error_code":"internal_server_error","message":"An unexpected error occurred.","details":{}}}},"exampleType":"generated"}},"description":"Internal Server Error","exampleType":"generated"}},"security":{},"servers":{"b45a6dfc-eec4-42ae-a72a-9361a1098054":{"url":"http://localhost:8080"}}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"adapter","siteName":"Adapter","title":"Get Connection - Adapter","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-16T23:17:24.285Z","originalFileLocation":"api-reference/connectors/get-connection.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns a connection by ID.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Adapter\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Connection - Adapter\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a connection by ID.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Adapter\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.beta.adapter.com/api-reference/connectors/get-connection\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://adapter.mintlify.app/_mintlify/api/og/v2?division=Connectors\u0026amp;title=Get+Connection\u0026amp;description=Returns+a+connection+by+ID.\u0026amp;theme=172df802757f1536c21dc595\u0026amp;signature=16424c2e4faa21962e62bc09a950eb8efc607248171a839568cf67a041be5b01\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Connection - Adapter\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a connection by ID.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://adapter.mintlify.app/_mintlify/api/og/v2?division=Connectors\u0026amp;title=Get+Connection\u0026amp;description=Returns+a+connection+by+ID.\u0026amp;theme=172df802757f1536c21dc595\u0026amp;signature=16424c2e4faa21962e62bc09a950eb8efc607248171a839568cf67a041be5b01\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/adapter/QFVp-gltrPnIPgdk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Adapter\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8765F0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.beta.adapter.com/api-reference/connectors/get-connection\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/connectors/get-connection.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.beta.adapter.com/#organization\",\"name\":\"Adapter\",\"url\":\"https://docs.beta.adapter.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/adapter/J3Ydy4fSe61BUDTE/logo/light.svg?fit=max\u0026auto=format\u0026n=J3Ydy4fSe61BUDTE\u0026q=85\u0026s=459bd6410eb825d264414176cd7eba07\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.beta.adapter.com#website\",\"name\":\"Adapter\",\"url\":\"https://docs.beta.adapter.com\",\"publisher\":{\"@id\":\"https://docs.beta.adapter.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.beta.adapter.com/api-reference/connectors/get-connection#webpage\",\"url\":\"https://docs.beta.adapter.com/api-reference/connectors/get-connection\",\"name\":\"Get Connection\",\"description\":\"Returns a connection by ID.\",\"dateModified\":\"2026-03-16T23:17:24.285Z\",\"isPartOf\":{\"@id\":\"https://docs.beta.adapter.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.beta.adapter.com/api-reference/connectors/get-connection#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.beta.adapter.com/api-reference/connectors/get-connection#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Connectors\",\"item\":\"https://docs.beta.adapter.com/api-reference/connectors/list-connections\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Connection\",\"item\":\"https://docs.beta.adapter.com/api-reference/connectors/get-connection\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.beta.adapter.com/api-reference/connectors/get-connection#apireference\",\"headline\":\"Get Connection\",\"name\":\"Get Connection\",\"description\":\"Returns a connection by ID.\",\"url\":\"https://docs.beta.adapter.com/api-reference/connectors/get-connection\",\"mainEntityOfPage\":{\"@id\":\"https://docs.beta.adapter.com/api-reference/connectors/get-connection#webpage\"},\"dateModified\":\"2026-03-16T23:17:24.285Z\",\"publisher\":{\"@id\":\"https://docs.beta.adapter.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.beta.adapter.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Adapter\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Adapter","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/getting-started/introduction"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/getting-started/mcp"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Overview","href":"/api-reference/introduction"}]},{"group":"Connectors","expanded":false,"pages":[{"title":"List Connections","openapi":"GET /v1/connections","description":"Returns a list of active connections.","href":"/api-reference/connectors/list-connections"},{"title":"Get Connection","openapi":"GET /v1/connections/{connection_id}","href":"/api-reference/connectors/get-connection"},{"title":"List Resource Facets","openapi":"GET /v1/connections/{connection_id}/resources/{resource}/facets/{facet_name}","description":"Return the live options for a facet declared by a resource.\n\nReplaces per-connector endpoints (e.g. /email/labels) with a single shape:\nthe resource declares its facets in ``BaseResource.facets`` and implements\n``list_facets`` to fetch the option set from the provider.","href":"/api-reference/connectors/list-resource-facets"}]},{"group":"Custom Connectors","expanded":false,"pages":[{"title":"List custom connectors","openapi":"GET /v1/custom-connectors","href":"/api-reference/custom-connectors/list-custom-connectors"},{"title":"Create a custom connector","openapi":"POST /v1/custom-connectors","href":"/api-reference/custom-connectors/create-custom-connector"},{"title":"Get a custom connector","openapi":"GET /v1/custom-connectors/{connector_id}","href":"/api-reference/custom-connectors/get-custom-connector"},{"title":"Update a custom connector","openapi":"PATCH /v1/custom-connectors/{connector_id}","href":"/api-reference/custom-connectors/update-custom-connector"},{"title":"Deactivate a custom connector","openapi":"DELETE /v1/custom-connectors/{connector_id}","href":"/api-reference/custom-connectors/delete-custom-connector"}]},{"group":"Data","expanded":false,"pages":[{"title":"Download Document Raw","openapi":"GET /v1/data/{connection_id}/{resource}/raw/{external_id}","href":"/api-reference/data/download-document-raw"},{"title":"Get Document Detail","openapi":"GET /v1/data/{connection_id}/{resource}/{external_id}","href":"/api-reference/data/get-document-detail"}]},{"group":"Documents","expanded":false,"pages":[{"title":"Get Document By Urn","openapi":"GET /v1/documents/{urn}","href":"/api-reference/documents/get-document-by-urn"},{"title":"Download Document By Urn","openapi":"GET /v1/documents/{urn}/raw","href":"/api-reference/documents/download-document-by-urn"}]},{"group":"Ingestion","expanded":false,"pages":[{"title":"Ingest generic JSON events","openapi":"POST /v1/custom-connectors/{connector_id}/ingest","href":"/api-reference/ingestion/ingest-custom"},{"title":"Upload a binary as a generic event","openapi":"POST /v1/custom-connectors/{connector_id}/ingest/upload","href":"/api-reference/ingestion/ingest-custom-upload"},{"title":"Start a presigned video upload","openapi":"POST /v1/custom-connectors/{connector_id}/ingest/video/upload-url","href":"/api-reference/ingestion/ingest-video-upload-url"},{"title":"Finalize a presigned video upload","openapi":"POST /v1/custom-connectors/{connector_id}/ingest/video/complete","href":"/api-reference/ingestion/ingest-video-complete"},{"title":"Ingest typed first-party events","openapi":"POST /v1/custom-connectors/{connector_id}/ingest/typed","href":"/api-reference/ingestion/ingest-typed"},{"title":"Upload a binary as a typed event","openapi":"POST /v1/custom-connectors/{connector_id}/ingest/typed/upload","href":"/api-reference/ingestion/ingest-typed-upload"}]},{"group":"Knowledge","expanded":false,"pages":[{"title":"Search","openapi":"POST /v1/knowledge/search","href":"/api-reference/knowledge/search"},{"title":"Ask","openapi":"POST /v1/knowledge/ask","href":"/api-reference/knowledge/ask"},{"title":"Ask Stream","openapi":"POST /v1/knowledge/ask/stream","href":"/api-reference/knowledge/ask-stream"},{"title":"List Ask Jobs","openapi":"GET /v1/knowledge/ask/jobs","href":"/api-reference/knowledge/list-ask-jobs"},{"title":"Create Ask Job","openapi":"POST /v1/knowledge/ask/jobs","href":"/api-reference/knowledge/create-ask-job"},{"title":"Get Ask Job","openapi":"GET /v1/knowledge/ask/jobs/{job_id}","href":"/api-reference/knowledge/get-ask-job"},{"title":"Get Entity","openapi":"GET /v1/knowledge/entities/{entity_id}","href":"/api-reference/knowledge/get-entity"},{"title":"Refresh Context","openapi":"POST /v1/knowledge/refresh","href":"/api-reference/knowledge/refresh-context"},{"title":"Context Status","openapi":"GET /v1/knowledge/status","href":"/api-reference/knowledge/context-status"},{"title":"Get Knowledge Settings","openapi":"GET /v1/knowledge/settings","href":"/api-reference/knowledge/get-knowledge-settings"},{"title":"Update Knowledge Settings","openapi":"PATCH /v1/knowledge/settings","href":"/api-reference/knowledge/update-knowledge-settings"}]},{"group":"Triggers","expanded":false,"pages":[{"title":"List triggers","openapi":"GET /v1/triggers","href":"/api-reference/Triggers/list-triggers"},{"title":"Create trigger","openapi":"POST /v1/triggers","href":"/api-reference/Triggers/create-trigger"},{"title":"List trigger registry","openapi":"GET /v1/triggers/kinds","href":"/api-reference/Triggers/list-trigger-kinds"},{"title":"Get delivery counts","openapi":"GET /v1/triggers/deliveries/summary","href":"/api-reference/Triggers/get-trigger-delivery-summary"},{"title":"Get trigger details","openapi":"GET /v1/triggers/{trigger_id}","href":"/api-reference/Triggers/get-trigger"},{"title":"Update trigger","openapi":"PATCH /v1/triggers/{trigger_id}","href":"/api-reference/Triggers/update-trigger"},{"title":"Delete trigger","openapi":"DELETE /v1/triggers/{trigger_id}","href":"/api-reference/Triggers/delete-trigger"},{"title":"List deliveries","openapi":"GET /v1/triggers/{trigger_id}/deliveries","href":"/api-reference/Triggers/list-trigger-deliveries"}]},{"group":"Writeback","expanded":false,"pages":[{"title":"Write agent output back into the workspace","openapi":"POST /v1/writeback","href":"/api-reference/writeback/write-back"},{"title":"Recently written-back items","openapi":"GET /v1/writeback/recent","href":"/api-reference/writeback/recent-writebacks"}]}]}]},"basePath":"","title":"Get Connection - Adapter","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}