Validate this credential and return its team, connection label, permissions and authorised mailboxes. No additional read permission or mailbox selection is required. Mailbox storage and sending availability are not checked. No user profile or secrets are returned.
Qubrics API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.
Headers
If-None-Match
string
ETag from a previous response. A match returns 304 with no body after rechecking authentication.
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Qubrics","description":"The intelligent email layer","colors":{"primary":"#6a75f1","light":"#5a84e9","dark":"#004aad"},"logo":{"light":"https://mintcdn.com/sendmux/9EML6-L2IAWgIXVX/images/logo-light.svg?fit=max\u0026auto=format\u0026n=9EML6-L2IAWgIXVX\u0026q=85\u0026s=0d301b6a4a28e21cf585335973584967","dark":"https://mintcdn.com/sendmux/9EML6-L2IAWgIXVX/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=9EML6-L2IAWgIXVX\u0026q=85\u0026s=612f5f9e57f97fd13812a619d185a2f9","href":"https://qubrics.com/docs"},"favicon":"https://mintcdn.com/sendmux/neuAiuAvPYRu89eG/images/favicon.svg?fit=max\u0026auto=format\u0026n=neuAiuAvPYRu89eG\u0026q=85\u0026s=557baee52eeabff3955db74427754525","api":{"params":{"expanded":"all"},"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript","go"],"autogenerate":true}},"appearance":{"default":"system"},"navbar":{"links":[{"href":"/changelog","label":"Changelog"},{"href":"mailto:contact@qubrics.com","label":"Support"}],"primary":{"type":"button","label":"App","href":"https://app.qubrics.com"}},"footer":{"socials":{"x":"https://x.com/sendmux","github":"https://github.com/qubrics"}},"seo":{"metatags":{"canonical":"https://qubrics.com/docs"}},"fonts":{"family":"Lato","weight":400},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"App","href":"https://app.qubrics.com"},{"anchor":"Website","href":"https://qubrics.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sendmux","hasAudioNarration":false,"actualSubdomain":"sendmux","customDomains":["qubrics.com"],"gitSource":{"type":"github","owner":"qubrics","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{},"buildId":"6b002092cf93c63408f0644f","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"Guides","count":79},{"language":"default","tag":"Management API","count":58},{"language":"default","tag":"Mailbox API","count":55},{"language":"default","tag":"AI integrations","count":32},{"language":"default","tag":"MCP","count":23},{"language":"default","tag":"Client setup","count":23},{"language":"default","tag":"Developer tools","count":20},{"language":"default","tag":"Sending accounts","count":18},{"language":"default","tag":"Mailboxes","count":15},{"language":"default","tag":"Messages","count":14}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"site-roles","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":"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":"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},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{font-size:103%}.antialiased{-webkit-font-smoothing:auto!important;-moz-osx-font-smoothing:auto!important}.h1,.h2,.h3,.h4,.h5,.h6,h1,h2,h3,h4,h5,h6,.prose h1,.prose h2,.prose h3,.prose h4,.prose h5,.prose h6{letter-spacing:var(--tracking-tight)!important}body,.prose,.prose p,.prose li,.prose td,.prose th,.prose blockquote{letter-spacing:0.00625rem!important}.eyebrow.h-5{text-transform:uppercase;letter-spacing:0.063em!important}h3.sidebar-title,#sidebar-title{display:flex;align-items:center;height:1.75rem;color:oklch(0.345 0.006 264 / 60%);text-transform:uppercase;font-size:0.7rem;font-weight:400;letter-spacing:0.044rem!important}.dark h3.sidebar-title,.dark #sidebar-title{color:oklch(0.985 0.001 106.423 / 60%)}"}]}
{"page":{"pagePath":"api/mailbox-api/get-mailbox-connection","slug":"/api/mailbox-api/get-mailbox-connection","pageMetadata":{"title":"Get Mailbox connection","description":"Validate this credential and return its team, connection label, permissions and authorised mailboxes. No additional read permission or mailbox selection is required. Mailbox storage and sending availability are not checked. No user profile or secrets are returned.","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/connection","href":"/api/mailbox-api/get-mailbox-connection","autogeneratedByOpenApi":true},"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: \"Validate this credential and return its team, connection label, permissions and authorised mailboxes. No additional read permission or mailbox selection is required. Mailbox storage and sending availability are not checked. No user profile or secrets are returned.\"\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 Mailbox connection","description":"Validate this credential and return its team, connection label, permissions and authorised mailboxes. No additional read permission or mailbox selection is required. Mailbox storage and sending availability are not checked. No user profile or secrets are returned.","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/connection","href":"/api/mailbox-api/get-mailbox-connection","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Validate this credential and return its team, connection label, permissions and authorised mailboxes. No additional read permission or mailbox selection is required. Mailbox storage and sending availability are not checked. No user profile or secrets are returned.","operationId":"mailboxGetConnection","parameters":["1ccbadee-8cb0-4198-b799-4819f9c6bd74"],"responses":{"200":"1bce5330-809e-4220-9ce6-f06a68ee770c","304":"9ec7a687-4f98-4688-acfd-08a8e8a8f8bc","401":"9d02c688-0514-4d39-af4d-0d05c14f7437","403":"cf280e3b-4a97-4b37-ba58-98a14c02ff54","429":"43356ad3-a427-4948-b122-198e95412395","500":"d75d7bd2-2151-4800-8407-f3858a0d84bf","503":"4ca270c2-87a5-4a4e-8339-ae34d1d80123"},"security":["c75bb517-8c5c-4bdd-995f-5089de9d4089","6efeba28-ded4-4799-b854-9d12a0fd98a5"],"summary":"Get Mailbox connection","tags":["Mailbox API"],"method":"get","type":"path","servers":["47cfcb91-0c9c-47bb-8bd6-fe2f163124de"],"path":"/mailbox/connection","baseUrlOptions":["https://app.qubrics.com/api/v1"],"title":"Get Mailbox connection","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","go"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"1ccbadee-8cb0-4198-b799-4819f9c6bd74":{"description":"ETag from a previous response. A match returns 304 with no body after rechecking authentication.","in":"header","name":"If-None-Match","required":false,"schema":{"type":"string","isRequired":false,"description":"ETag from a previous response. A match returns 304 with no body after rechecking authentication.","uniqueKey":"","typeLabel":"string"}}},"responses":{"1bce5330-809e-4220-9ce6-f06a68ee770c":{"content":{"application/json":{"schema":{"type":"object","required":["data","ok","meta"],"properties":{"meta":{"type":"object","required":["request_id"],"properties":{"request_id":{"example":"req_clxxxxxxxxxxxxxxxxxxxxxxxxx","type":"string","isRequired":true,"uniqueKey":"meta.request_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"meta","typeLabel":"object"},"ok":{"enum":[true],"type":"boolean","isRequired":true,"uniqueKey":"ok","typeLabel":"enum\u003cboolean>"},"data":{"additionalProperties":false,"properties":{"credential":{"additionalProperties":false,"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.credential.id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.credential.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.credential.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.credential.name","typeLabel":"string | null"},"type":{"enum":["api_key","oauth","agent_token"],"example":"api_key","type":"string","isRequired":true,"uniqueKey":"data.credential.type","typeLabel":"enum\u003cstring>"}},"required":["id","type","name"],"type":"object","isRequired":true,"uniqueKey":"data.credential","typeLabel":"object"},"label":{"description":"Display label for this connection.","type":"string","isRequired":true,"uniqueKey":"data.label","typeLabel":"string"},"mailboxes":{"items":{"additionalProperties":false,"properties":{"email":{"format":"email","type":"string","isRequired":true,"uniqueKey":"data.mailboxes.items.[INDEX].email","typeLabel":"string\u003cemail>"},"id":{"type":"string","isRequired":true,"uniqueKey":"data.mailboxes.items.[INDEX].id","typeLabel":"string"}},"required":["id","email"],"type":"object","uniqueKey":"data.mailboxes.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.mailboxes","typeLabel":"object[]"},"permissions":{"items":{"type":"string","uniqueKey":"data.permissions.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"data.permissions","typeLabel":"string[]"},"team":{"additionalProperties":false,"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.team.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.team.name","typeLabel":"string"}},"required":["id","name"],"type":"object","isRequired":true,"uniqueKey":"data.team","typeLabel":"object"}},"required":["team","credential","label","permissions","mailboxes"],"type":"object","isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"meta":{"request_id":"req_clxxxxxxxxxxxxxxxxxxxxxxxxx"},"ok":true,"data":{"credential":{"id":"\u003cstring>","name":"\u003cstring>","type":"api_key"},"label":"\u003cstring>","mailboxes":[{"email":"jsmith@example.com","id":"\u003cstring>"}],"permissions":["\u003cstring>"],"team":{"id":"\u003cstring>","name":"\u003cstring>"}}}}},"exampleType":"generated"}},"description":"Connection information","headers":{"Cache-Control":{"description":"Always no-store.","schema":{"type":"string"}},"ETag":{"schema":{"type":"string"}},"X-Request-Id":{"description":"Request identifier.","schema":{"type":"string"}}},"exampleType":"generated"},"9ec7a687-4f98-4688-acfd-08a8e8a8f8bc":{"description":"Connection information is unchanged. Authentication is checked on every request.","headers":{"Cache-Control":{"description":"Always no-store.","schema":{"type":"string"}},"X-Request-Id":{"description":"Request identifier.","schema":{"type":"string"}}},"content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"9d02c688-0514-4d39-af4d-0d05c14f7437":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"error":{"additionalProperties":false,"properties":{"code":{"description":"Machine-readable error code","enum":["invalid_parameter","missing_parameter","authentication_required","insufficient_permissions","not_found","conflict","limit_exceeded","idempotency_conflict","payload_too_large","validation_error","rate_limit_exceeded","service_unavailable","internal_error"],"example":"invalid_parameter","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable error description","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"description":"Whether the caller may safely retry this request. 4xx are typically false (except 429); 5xx are typically true.","example":false,"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"doc_url":{"description":"Link to relevant documentation","type":"string","uniqueKey":"error.doc_url","typeLabel":"string"},"errors":{"description":"Accumulated per-field issues for validation errors. Only present on 400/422 responses.","items":{"additionalProperties":false,"properties":{"code":{"description":"Machine-readable issue code from the validator (e.g. zod issue code).","example":"invalid_string","type":"string","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].code","typeLabel":"string"},"field":{"description":"Dot-path of the offending request field.","example":"recipient.email","type":"string","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].field","typeLabel":"string"},"message":{"description":"Human-readable issue description.","type":"string","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"error.errors","typeLabel":"object[]"},"param":{"description":"The parameter that caused the error","type":"string","uniqueKey":"error.param","typeLabel":"string"}},"required":["code","message","retryable"],"type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"additionalProperties":false,"properties":{"request_id":{"example":"req_clxxxxxxxxxxxxxxxxxxxxxxxxx","type":"string","isRequired":true,"uniqueKey":"meta.request_id","typeLabel":"string"}},"required":["request_id"],"type":"object","isRequired":true,"uniqueKey":"meta","typeLabel":"object"},"ok":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"ok","typeLabel":"enum\u003cboolean>"}},"required":["ok","error","meta"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_parameter","message":"\u003cstring>","retryable":false,"doc_url":"\u003cstring>","errors":[{"code":"invalid_string","field":"recipient.email","message":"\u003cstring>"}],"param":"\u003cstring>"},"meta":{"request_id":"req_clxxxxxxxxxxxxxxxxxxxxxxxxx"},"ok":false}}},"exampleType":"generated"}},"description":"Authentication required","exampleType":"generated"},"cf280e3b-4a97-4b37-ba58-98a14c02ff54":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"error":{"additionalProperties":false,"properties":{"code":{"description":"Machine-readable error code","enum":["invalid_parameter","missing_parameter","authentication_required","insufficient_permissions","not_found","conflict","limit_exceeded","idempotency_conflict","payload_too_large","validation_error","rate_limit_exceeded","service_unavailable","internal_error"],"example":"invalid_parameter","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable error description","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"description":"Whether the caller may safely retry this request. 4xx are typically false (except 429); 5xx are typically true.","example":false,"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"doc_url":{"description":"Link to relevant documentation","type":"string","uniqueKey":"error.doc_url","typeLabel":"string"},"errors":{"description":"Accumulated per-field issues for validation errors. Only present on 400/422 responses.","items":{"additionalProperties":false,"properties":{"code":{"description":"Machine-readable issue code from the validator (e.g. zod issue code).","example":"invalid_string","type":"string","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].code","typeLabel":"string"},"field":{"description":"Dot-path of the offending request field.","example":"recipient.email","type":"string","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].field","typeLabel":"string"},"message":{"description":"Human-readable issue description.","type":"string","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"error.errors","typeLabel":"object[]"},"param":{"description":"The parameter that caused the error","type":"string","uniqueKey":"error.param","typeLabel":"string"}},"required":["code","message","retryable"],"type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"additionalProperties":false,"properties":{"request_id":{"example":"req_clxxxxxxxxxxxxxxxxxxxxxxxxx","type":"string","isRequired":true,"uniqueKey":"meta.request_id","typeLabel":"string"}},"required":["request_id"],"type":"object","isRequired":true,"uniqueKey":"meta","typeLabel":"object"},"ok":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"ok","typeLabel":"enum\u003cboolean>"}},"required":["ok","error","meta"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_parameter","message":"\u003cstring>","retryable":false,"doc_url":"\u003cstring>","errors":[{"code":"invalid_string","field":"recipient.email","message":"\u003cstring>"}],"param":"\u003cstring>"},"meta":{"request_id":"req_clxxxxxxxxxxxxxxxxxxxxxxxxx"},"ok":false}}},"exampleType":"generated"}},"description":"Credential is not authorised for this API","exampleType":"generated"},"43356ad3-a427-4948-b122-198e95412395":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"error":{"additionalProperties":false,"properties":{"code":{"description":"Machine-readable error code","enum":["invalid_parameter","missing_parameter","authentication_required","insufficient_permissions","not_found","conflict","limit_exceeded","idempotency_conflict","payload_too_large","validation_error","rate_limit_exceeded","service_unavailable","internal_error"],"example":"invalid_parameter","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable error description","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"description":"Whether the caller may safely retry this request. 4xx are typically false (except 429); 5xx are typically true.","example":false,"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"doc_url":{"description":"Link to relevant documentation","type":"string","uniqueKey":"error.doc_url","typeLabel":"string"},"errors":{"description":"Accumulated per-field issues for validation errors. Only present on 400/422 responses.","items":{"additionalProperties":false,"properties":{"code":{"description":"Machine-readable issue code from the validator (e.g. zod issue code).","example":"invalid_string","type":"string","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].code","typeLabel":"string"},"field":{"description":"Dot-path of the offending request field.","example":"recipient.email","type":"string","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].field","typeLabel":"string"},"message":{"description":"Human-readable issue description.","type":"string","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"error.errors","typeLabel":"object[]"},"param":{"description":"The parameter that caused the error","type":"string","uniqueKey":"error.param","typeLabel":"string"}},"required":["code","message","retryable"],"type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"additionalProperties":false,"properties":{"request_id":{"example":"req_clxxxxxxxxxxxxxxxxxxxxxxxxx","type":"string","isRequired":true,"uniqueKey":"meta.request_id","typeLabel":"string"}},"required":["request_id"],"type":"object","isRequired":true,"uniqueKey":"meta","typeLabel":"object"},"ok":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"ok","typeLabel":"enum\u003cboolean>"}},"required":["ok","error","meta"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_parameter","message":"\u003cstring>","retryable":false,"doc_url":"\u003cstring>","errors":[{"code":"invalid_string","field":"recipient.email","message":"\u003cstring>"}],"param":"\u003cstring>"},"meta":{"request_id":"req_clxxxxxxxxxxxxxxxxxxxxxxxxx"},"ok":false}}},"exampleType":"generated"}},"description":"Rate limit exceeded","headers":{"Retry-After":{"schema":{"type":"string"}}},"exampleType":"generated"},"d75d7bd2-2151-4800-8407-f3858a0d84bf":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"error":{"additionalProperties":false,"properties":{"code":{"description":"Machine-readable error code","enum":["invalid_parameter","missing_parameter","authentication_required","insufficient_permissions","not_found","conflict","limit_exceeded","idempotency_conflict","payload_too_large","validation_error","rate_limit_exceeded","service_unavailable","internal_error"],"example":"invalid_parameter","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable error description","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"description":"Whether the caller may safely retry this request. 4xx are typically false (except 429); 5xx are typically true.","example":false,"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"doc_url":{"description":"Link to relevant documentation","type":"string","uniqueKey":"error.doc_url","typeLabel":"string"},"errors":{"description":"Accumulated per-field issues for validation errors. Only present on 400/422 responses.","items":{"additionalProperties":false,"properties":{"code":{"description":"Machine-readable issue code from the validator (e.g. zod issue code).","example":"invalid_string","type":"string","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].code","typeLabel":"string"},"field":{"description":"Dot-path of the offending request field.","example":"recipient.email","type":"string","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].field","typeLabel":"string"},"message":{"description":"Human-readable issue description.","type":"string","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"error.errors","typeLabel":"object[]"},"param":{"description":"The parameter that caused the error","type":"string","uniqueKey":"error.param","typeLabel":"string"}},"required":["code","message","retryable"],"type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"additionalProperties":false,"properties":{"request_id":{"example":"req_clxxxxxxxxxxxxxxxxxxxxxxxxx","type":"string","isRequired":true,"uniqueKey":"meta.request_id","typeLabel":"string"}},"required":["request_id"],"type":"object","isRequired":true,"uniqueKey":"meta","typeLabel":"object"},"ok":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"ok","typeLabel":"enum\u003cboolean>"}},"required":["ok","error","meta"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_parameter","message":"\u003cstring>","retryable":false,"doc_url":"\u003cstring>","errors":[{"code":"invalid_string","field":"recipient.email","message":"\u003cstring>"}],"param":"\u003cstring>"},"meta":{"request_id":"req_clxxxxxxxxxxxxxxxxxxxxxxxxx"},"ok":false}}},"exampleType":"generated"}},"description":"Unexpected server error","exampleType":"generated"},"4ca270c2-87a5-4a4e-8339-ae34d1d80123":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"error":{"additionalProperties":false,"properties":{"code":{"description":"Machine-readable error code","enum":["invalid_parameter","missing_parameter","authentication_required","insufficient_permissions","not_found","conflict","limit_exceeded","idempotency_conflict","payload_too_large","validation_error","rate_limit_exceeded","service_unavailable","internal_error"],"example":"invalid_parameter","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable error description","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"description":"Whether the caller may safely retry this request. 4xx are typically false (except 429); 5xx are typically true.","example":false,"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"doc_url":{"description":"Link to relevant documentation","type":"string","uniqueKey":"error.doc_url","typeLabel":"string"},"errors":{"description":"Accumulated per-field issues for validation errors. Only present on 400/422 responses.","items":{"additionalProperties":false,"properties":{"code":{"description":"Machine-readable issue code from the validator (e.g. zod issue code).","example":"invalid_string","type":"string","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].code","typeLabel":"string"},"field":{"description":"Dot-path of the offending request field.","example":"recipient.email","type":"string","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].field","typeLabel":"string"},"message":{"description":"Human-readable issue description.","type":"string","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"error.errors","typeLabel":"object[]"},"param":{"description":"The parameter that caused the error","type":"string","uniqueKey":"error.param","typeLabel":"string"}},"required":["code","message","retryable"],"type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"object"},"meta":{"additionalProperties":false,"properties":{"request_id":{"example":"req_clxxxxxxxxxxxxxxxxxxxxxxxxx","type":"string","isRequired":true,"uniqueKey":"meta.request_id","typeLabel":"string"}},"required":["request_id"],"type":"object","isRequired":true,"uniqueKey":"meta","typeLabel":"object"},"ok":{"enum":[false],"type":"boolean","isRequired":true,"uniqueKey":"ok","typeLabel":"enum\u003cboolean>"}},"required":["ok","error","meta"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_parameter","message":"\u003cstring>","retryable":false,"doc_url":"\u003cstring>","errors":[{"code":"invalid_string","field":"recipient.email","message":"\u003cstring>"}],"param":"\u003cstring>"},"meta":{"request_id":"req_clxxxxxxxxxxxxxxxxxxxxxxxxx"},"ok":false}}},"exampleType":"generated"}},"description":"Authentication service temporarily unavailable","headers":{"Retry-After":{"schema":{"type":"string"}}},"exampleType":"generated"}},"security":{"c75bb517-8c5c-4bdd-995f-5089de9d4089":{"bearerAuth":{"bearerFormat":"API Key","description":"Qubrics API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearerAuth"}},"6efeba28-ded4-4799-b854-9d12a0fd98a5":{"oauth2":{"description":"Use the authorisation-code flow with S256 PKCE and resource=https://qubrics.com/api. The user selects the team, API access and mailboxes during consent. OAuth access tokens authenticate HTTP API requests; use separate credentials for SMTP and IMAP.","flows":{"authorizationCode":{"authorizationUrl":"https://app.qubrics.com/oauth/authorize","refreshUrl":"https://app.qubrics.com/oauth/token","scopes":{"analytics.*":"All analytics operations","analytics.read":"View key usage analytics and verification logs","billing.*":"All billing operations","billing.auto_topup":"Configure auto top-up settings","billing.read":"View balance, transactions, invoices","billing.topup":"Purchase balance top-ups","calendar.read":"Read calendars and events in this mailbox","calendar.write":"Create calendars and create, edit and delete events in this mailbox","domain.*":"All domain operations","domain.create":"Add sending domains","domain.delete":"Remove domains","domain.read":"List/view domains and DNS status","domain.verify":"Trigger domain verification","email.receive":"Authorise email reception","email.send":"Send email through the HTTP API","key.*":"All key management operations","key.create":"Create new API keys (both root and mailbox)","key.read":"List/view API keys and their metadata","key.revoke":"Revoke API keys","key.rotate":"Rotate API keys","logs.*":"All log operations","logs.read":"View delivery logs","mailbox.admin.*":"All mailbox admin operations","mailbox.admin.create":"Create mailboxes (admin-level)","mailbox.admin.delete":"Delete mailboxes (admin-level)","mailbox.admin.manage":"Manage all mailbox settings","mailbox.admin.read":"List/view mailboxes (admin-level)","mailbox.drafts.write":"Create and edit saved mailbox drafts","mailbox.read":"Read mailbox contents (folders, messages)","mailbox.settings.update":"Update own mailbox settings (signature, auto-reply)","provider.*":"All provider operations","provider.create":"Add email provider accounts (Google, Microsoft, SMTP)","provider.delete":"Remove provider accounts","provider.read":"List/view provider accounts and connection status","provider.update":"Update provider settings, refresh tokens","routing.*":"All routing operations","routing.create":"Create delivery groups","routing.delete":"Remove delivery groups","routing.read":"List/view delivery groups and routing rules","routing.update":"Update delivery group configuration","team.*":"All team operations","team.members.invite":"Invite team members","team.members.remove":"Remove team members","team.members.roles":"Change member roles","team.read":"View team settings and members","team.update":"Update team settings","webhook.*":"All webhook operations","webhook.create":"Create webhook subscriptions","webhook.delete":"Delete webhook subscriptions","webhook.manage":"Rotate signing secret + send test events","webhook.read":"List/view webhook subscriptions","webhook.update":"Update webhook URL, event types, enabled flag"},"tokenUrl":"https://app.qubrics.com/oauth/token"}},"type":"oauth2","scopes":[],"schemeName":"oauth2"}}},"servers":{"47cfcb91-0c9c-47bb-8bd6-fe2f163124de":{"description":"API v1","url":"https://app.qubrics.com/api/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"bearerFormat":"API Key","description":"Qubrics API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Qubrics API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"},{"schemes":[{"scheme":{"description":"Use the authorisation-code flow with S256 PKCE and resource=https://qubrics.com/api. The user selects the team, API access and mailboxes during consent. OAuth access tokens authenticate HTTP API requests; use separate credentials for SMTP and IMAP.","flows":{"authorizationCode":{"authorizationUrl":"https://app.qubrics.com/oauth/authorize","refreshUrl":"https://app.qubrics.com/oauth/token","scopes":{"analytics.*":"All analytics operations","analytics.read":"View key usage analytics and verification logs","billing.*":"All billing operations","billing.auto_topup":"Configure auto top-up settings","billing.read":"View balance, transactions, invoices","billing.topup":"Purchase balance top-ups","calendar.read":"Read calendars and events in this mailbox","calendar.write":"Create calendars and create, edit and delete events in this mailbox","domain.*":"All domain operations","domain.create":"Add sending domains","domain.delete":"Remove domains","domain.read":"List/view domains and DNS status","domain.verify":"Trigger domain verification","email.receive":"Authorise email reception","email.send":"Send email through the HTTP API","key.*":"All key management operations","key.create":"Create new API keys (both root and mailbox)","key.read":"List/view API keys and their metadata","key.revoke":"Revoke API keys","key.rotate":"Rotate API keys","logs.*":"All log operations","logs.read":"View delivery logs","mailbox.admin.*":"All mailbox admin operations","mailbox.admin.create":"Create mailboxes (admin-level)","mailbox.admin.delete":"Delete mailboxes (admin-level)","mailbox.admin.manage":"Manage all mailbox settings","mailbox.admin.read":"List/view mailboxes (admin-level)","mailbox.drafts.write":"Create and edit saved mailbox drafts","mailbox.read":"Read mailbox contents (folders, messages)","mailbox.settings.update":"Update own mailbox settings (signature, auto-reply)","provider.*":"All provider operations","provider.create":"Add email provider accounts (Google, Microsoft, SMTP)","provider.delete":"Remove provider accounts","provider.read":"List/view provider accounts and connection status","provider.update":"Update provider settings, refresh tokens","routing.*":"All routing operations","routing.create":"Create delivery groups","routing.delete":"Remove delivery groups","routing.read":"List/view delivery groups and routing rules","routing.update":"Update delivery group configuration","team.*":"All team operations","team.members.invite":"Invite team members","team.members.remove":"Remove team members","team.members.roles":"Change member roles","team.read":"View team settings and members","team.update":"Update team settings","webhook.*":"All webhook operations","webhook.create":"Create webhook subscriptions","webhook.delete":"Delete webhook subscriptions","webhook.manage":"Rotate signing secret + send test events","webhook.read":"List/view webhook subscriptions","webhook.update":"Update webhook URL, event types, enabled flag"},"tokenUrl":"https://app.qubrics.com/oauth/token"}},"type":"oauth2","scopes":[],"schemeName":"oauth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"Use the authorisation-code flow with S256 PKCE and resource=https://qubrics.com/api. The user selects the team, API access and mailboxes during consent. OAuth access tokens authenticate HTTP API requests; use separate credentials for SMTP and IMAP.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2","name":"Authorization"}],"title":"oauth2"}]},"originalFileLocation":"openapi-app.json"},"subdomain":"sendmux","siteName":"Qubrics","title":"Get Mailbox connection - Qubrics","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-19T05:44:28.298Z","originalFileLocation":"api/mailbox-api/get-mailbox-connection.mdx"},"headHtml":"\u003cscript data-mint-head\u003e(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\u003e\u003cmeta data-mint-head name=\"description\" content=\"Validate this credential and return its team, connection label, permissions and authorised mailboxes. No additional read permission or mailbox selection is required. Mailbox storage and sending availability are not checked. No user profile or secrets are returned.\"\u003e\u003cmeta data-mint-head name=\"application-name\" content=\"Qubrics\"\u003e\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\"\u003e\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/qubrics/QBifi-yrmD9atxWJ/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\"\u003e\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/qubrics/QBifi-yrmD9atxWJ/_generated/favicon/apple-touch-icon.png\"\u003e\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/qubrics/QBifi-yrmD9atxWJ/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\"\u003e\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/qubrics/QBifi-yrmD9atxWJ/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\"\u003e\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/qubrics/QBifi-yrmD9atxWJ/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\"\u003e\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/qubrics/QBifi-yrmD9atxWJ/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\"\u003e\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/qubrics/QBifi-yrmD9atxWJ/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\"\u003e\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/qubrics/QBifi-yrmD9atxWJ/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\"\u003e\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/qubrics/QBifi-yrmD9atxWJ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\"\u003e\u003cmeta data-mint-head property=\"og:title\" content=\"Get Mailbox connection - Qubrics\"\u003e\u003cmeta data-mint-head property=\"og:description\" content=\"Validate this credential and return its team, connection label, permissions and authorised mailboxes. No additional read permission or mailbox selection is required. Mailbox storage and sending availability are not checked. No user profile or secrets are returned.\"\u003e\u003cmeta data-mint-head property=\"og:site_name\" content=\"Qubrics\"\u003e\u003cmeta data-mint-head property=\"og:url\" content=\"https://qubrics.com/docs/api/mailbox-api/get-mailbox-connection\"\u003e\u003cmeta data-mint-head property=\"og:type\" content=\"website\"\u003e\u003cmeta data-mint-head property=\"og:image\" content=\"https://qubrics.com/docs/_mintlify/api/og/v2?division=Overview\u0026amp;title=Get+Mailbox+connection\u0026amp;description=Validate+this+credential+and+return+its+team%2C+connection+label%2C+permissions+and+authorised+mailboxes.+No+additional+read+permission+or+mailbox+selection+is+requ\u0026amp;theme=8d3480837e3238732b09c327\u0026amp;signature=82ec4d8871487b3603c32ab6b303acfa07f778d74010741e519df3ca1ce74790\"\u003e\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\"\u003e\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\"\u003e\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\"\u003e\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Mailbox connection - Qubrics\"\u003e\u003cmeta data-mint-head name=\"twitter:description\" content=\"Validate this credential and return its team, connection label, permissions and authorised mailboxes. No additional read permission or mailbox selection is required. Mailbox storage and sending availability are not checked. No user profile or secrets are returned.\"\u003e\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://qubrics.com/docs/_mintlify/api/og/v2?division=Overview\u0026amp;title=Get+Mailbox+connection\u0026amp;description=Validate+this+credential+and+return+its+team%2C+connection+label%2C+permissions+and+authorised+mailboxes.+No+additional+read+permission+or+mailbox+selection+is+requ\u0026amp;theme=8d3480837e3238732b09c327\u0026amp;signature=82ec4d8871487b3603c32ab6b303acfa07f778d74010741e519df3ca1ce74790\"\u003e\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\"\u003e\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\"\u003e\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/sendmux/QBifi-yrmD9atxWJ/_generated/favicon/browserconfig.xml\"\u003e\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Qubrics\"\u003e\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6a75f1\"\u003e\u003clink data-mint-head rel=\"canonical\" href=\"https://qubrics.com/docs/api/mailbox-api/get-mailbox-connection\"\u003e\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\"\u003e\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api/mailbox-api/get-mailbox-connection.md\"\u003e\u003cscript data-mint-head type=\"application/ld+json\"\u003e{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://qubrics.com/#organization\",\"name\":\"Qubrics\",\"url\":\"https://qubrics.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sendmux/9EML6-L2IAWgIXVX/images/logo-light.svg?fit=max\u0026auto=format\u0026n=9EML6-L2IAWgIXVX\u0026q=85\u0026s=0d301b6a4a28e21cf585335973584967\"}},{\"@type\":\"WebSite\",\"@id\":\"https://qubrics.com/docs#website\",\"name\":\"Qubrics\",\"url\":\"https://qubrics.com/docs\",\"publisher\":{\"@id\":\"https://qubrics.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://qubrics.com/docs/api/mailbox-api/get-mailbox-connection#webpage\",\"url\":\"https://qubrics.com/docs/api/mailbox-api/get-mailbox-connection\",\"name\":\"Get Mailbox connection\",\"description\":\"Validate this credential and return its team, connection label, permissions and authorised mailboxes. No additional read permission or mailbox selection is required. Mailbox storage and sending availability are not checked. No user profile or secrets are returned.\",\"dateModified\":\"2026-11-19T05:44:28.298Z\",\"isPartOf\":{\"@id\":\"https://qubrics.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://qubrics.com/docs/api/mailbox-api/get-mailbox-connection#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://qubrics.com/docs/api/mailbox-api/get-mailbox-connection#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Overview\",\"item\":\"https://qubrics.com/docs/mailbox-api/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Mailbox connection\",\"item\":\"https://qubrics.com/docs/api/mailbox-api/get-mailbox-connection\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://qubrics.com/docs/api/mailbox-api/get-mailbox-connection#apireference\",\"headline\":\"Get Mailbox connection\",\"name\":\"Get Mailbox connection\",\"description\":\"Validate this credential and return its team, connection label, permissions and authorised mailboxes. No additional read permission or mailbox selection is required. Mailbox storage and sending availability are not checked. No user profile or secrets are returned.\",\"url\":\"https://qubrics.com/docs/api/mailbox-api/get-mailbox-connection\",\"mainEntityOfPage\":{\"@id\":\"https://qubrics.com/docs/api/mailbox-api/get-mailbox-connection#webpage\"},\"dateModified\":\"2026-11-19T05:44:28.298Z\",\"publisher\":{\"@id\":\"https://qubrics.com/#organization\"},\"isPartOf\":{\"@id\":\"https://qubrics.com/docs#website\"}}]}\u003c/script\u003e\u003cscript data-mint-head type=\"application/ld+json\"\u003e{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Qubrics\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Qubrics\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script\u003e","agentPointerHref":"/docs/api/mailbox-api/get-mailbox-connection.md","siteName":"Qubrics","nav":{"global":{"anchors":[{"anchor":"App","href":"https://app.qubrics.com"},{"anchor":"Website","href":"https://qubrics.com"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"Management API","pages":[{"title":"Management API","href":"/api/introduction"}]},{"tab":"Mailbox API","groups":[{"group":"Overview","pages":[{"title":"Introduction","href":"/mailbox-api/introduction"},{"title":"Errors","description":"Error codes and handling for the Qubrics Mailbox API.","href":"/mailbox-api/errors"},{"title":"Get Mailbox connection","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/connection","href":"/api/mailbox-api/get-mailbox-connection"}]},{"group":"Mailboxes","pages":[{"title":"List granted mailboxes","description":"Lists the mailboxes available to the current mailbox credential or connected app. Use this before choosing a `mailbox_id` for mailbox actions when more than one mailbox is available.","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/mailboxes","href":"/api/mailbox-api/list-granted-mailboxes"}]},{"group":"Session and identity","pages":[{"title":"Self-introspect the calling mailbox","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/me","href":"/api/mailbox-api/self-introspect-the-calling-mailbox"},{"title":"Get mailbox API session","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/session","href":"/api/mailbox-api/get-mailbox-api-session"},{"title":"Get permitted sender choices","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/sender-choices","href":"/api/mailbox-api/get-permitted-sender-choices"},{"title":"Get mailbox sender identity","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/identity","href":"/api/mailbox-api/get-mailbox-sender-identity"},{"title":"Update mailbox sender identity","deprecated":null,"version":null,"openapi":"/openapi-app.json patch /mailbox/identity","href":"/api/mailbox-api/update-mailbox-sender-identity"},{"title":"List mailbox sender identities","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/identities","href":"/api/mailbox-api/list-mailbox-sender-identities"}]},{"group":"Messages","pages":[{"title":"List mailbox messages","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/messages","href":"/api/mailbox-api/list-mailbox-messages"},{"title":"Batch get mailbox messages","deprecated":null,"version":null,"openapi":"/openapi-app.json post /mailbox/messages:batch-get","href":"/api/mailbox-api/batch-get-mailbox-messages"},{"title":"Batch update mailbox messages","deprecated":null,"version":null,"openapi":"/openapi-app.json post /mailbox/messages:batch-update","href":"/api/mailbox-api/batch-update-mailbox-messages"},{"title":"Batch delete mailbox messages","deprecated":null,"version":null,"openapi":"/openapi-app.json post /mailbox/messages:batch-delete","href":"/api/mailbox-api/batch-delete-mailbox-messages"},{"title":"Count mailbox messages","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/messages/count","href":"/api/mailbox-api/count-mailbox-messages"},{"title":"Get message query changes","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/messages/query-changes","href":"/api/mailbox-api/get-message-query-changes"},{"title":"Get message search snippets","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/messages/search-snippets","href":"/api/mailbox-api/get-message-search-snippets"},{"title":"Get a mailbox message","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/messages/{message_id}","href":"/api/mailbox-api/get-a-mailbox-message"},{"title":"Get raw message body","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/messages/{message_id}/body","href":"/api/mailbox-api/get-raw-message-body"},{"title":"Get clean message content","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/messages/{message_id}/content","href":"/api/mailbox-api/get-clean-message-content"},{"title":"Download the original message","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/messages/{message_id}/raw","href":"/api/mailbox-api/download-the-original-message"},{"title":"Update mailbox message flags","deprecated":null,"version":null,"openapi":"/openapi-app.json patch /mailbox/messages/{message_id}","href":"/api/mailbox-api/update-mailbox-message-flags"},{"title":"Delete a mailbox message","deprecated":null,"version":null,"openapi":"/openapi-app.json delete /mailbox/messages/{message_id}","href":"/api/mailbox-api/delete-a-mailbox-message"},{"title":"Send a mailbox message","deprecated":null,"version":null,"openapi":"/openapi-app.json post /mailbox/messages/send","href":"/api/mailbox-api/send-a-mailbox-message"}]},{"group":"Saved drafts","pages":[{"title":"List saved drafts","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/drafts","href":"/api/mailbox-api/list-saved-drafts"},{"title":"Create a saved draft","deprecated":null,"version":null,"openapi":"/openapi-app.json post /mailbox/drafts","href":"/api/mailbox-api/create-a-saved-draft"},{"title":"Read a saved draft","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/drafts/{draftId}","href":"/api/mailbox-api/read-a-saved-draft"},{"title":"Edit a saved draft","deprecated":null,"version":null,"openapi":"/openapi-app.json patch /mailbox/drafts/{draftId}","href":"/api/mailbox-api/edit-a-saved-draft"},{"title":"Delete a saved draft","deprecated":null,"version":null,"openapi":"/openapi-app.json delete /mailbox/drafts/{draftId}","href":"/api/mailbox-api/delete-a-saved-draft"},{"title":"Send a saved draft revision","deprecated":null,"version":null,"openapi":"/openapi-app.json post /mailbox/drafts/{draftId}/send","href":"/api/mailbox-api/send-a-saved-draft-revision"},{"title":"Reschedule or cancel a saved draft send","deprecated":null,"version":null,"openapi":"/openapi-app.json patch /mailbox/drafts/{draftId}/schedule","href":"/api/mailbox-api/reschedule-or-cancel-a-saved-draft-send"}]},{"group":"Attachments","pages":[{"title":"Upload a mailbox attachment","deprecated":null,"version":null,"openapi":"/openapi-app.json post /mailbox/attachments:upload","href":"/api/mailbox-api/upload-a-mailbox-attachment"},{"title":"Create a presigned mailbox attachment upload","deprecated":null,"version":null,"openapi":"/openapi-app.json post /mailbox/attachment-uploads","href":"/api/mailbox-api/create-a-presigned-mailbox-attachment-upload"},{"title":"Download a message attachment","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/messages/{message_id}/attachments/{attachment_id}","href":"/api/mailbox-api/download-a-message-attachment"},{"title":"Request attachment text","deprecated":null,"version":null,"openapi":"/openapi-app.json post /mailbox/messages/{message_id}/attachments/{attachment_id}/text","href":"/api/mailbox-api/request-attachment-text"},{"title":"Read attachment text","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/messages/{message_id}/attachments/{attachment_id}/text","href":"/api/mailbox-api/read-attachment-text"}]},{"group":"Threads","pages":[{"title":"List mailbox threads","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/threads","href":"/api/mailbox-api/list-mailbox-threads"},{"title":"Get a mailbox thread","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/threads/{thread_id}","href":"/api/mailbox-api/get-a-mailbox-thread"},{"title":"List thread messages","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/threads/{thread_id}/messages","href":"/api/mailbox-api/list-thread-messages"},{"title":"Get clean thread content","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/threads/{thread_id}/content","href":"/api/mailbox-api/get-clean-thread-content"}]},{"group":"Folders","pages":[{"title":"List mailbox folders","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/folders","href":"/api/mailbox-api/list-mailbox-folders"},{"title":"Create a mailbox folder","deprecated":null,"version":null,"openapi":"/openapi-app.json post /mailbox/folders","href":"/api/mailbox-api/create-a-mailbox-folder"},{"title":"Get folder changes","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/folders/changes","href":"/api/mailbox-api/get-folder-changes"},{"title":"Get folder query changes","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/folders/query-changes","href":"/api/mailbox-api/get-folder-query-changes"},{"title":"Get a mailbox folder","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/folders/{folder_id}","href":"/api/mailbox-api/get-a-mailbox-folder"},{"title":"Update a mailbox folder","deprecated":null,"version":null,"openapi":"/openapi-app.json patch /mailbox/folders/{folder_id}","href":"/api/mailbox-api/update-a-mailbox-folder"},{"title":"Delete a mailbox folder","deprecated":null,"version":null,"openapi":"/openapi-app.json delete /mailbox/folders/{folder_id}","href":"/api/mailbox-api/delete-a-mailbox-folder"}]},{"group":"Submissions","pages":[{"title":"List mailbox submissions","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/submissions","href":"/api/mailbox-api/list-mailbox-submissions"},{"title":"Get submission changes","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/submissions/changes","href":"/api/mailbox-api/get-submission-changes"},{"title":"Get a mailbox submission","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/submissions/{submission_id}","href":"/api/mailbox-api/get-a-mailbox-submission"}]},{"group":"Usage","pages":[{"title":"List mailbox quotas","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/quotas","href":"/api/mailbox-api/list-mailbox-quotas"},{"title":"Get quota changes","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/quotas/changes","href":"/api/mailbox-api/get-quota-changes"},{"title":"Get mailbox usage","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/usage","href":"/api/mailbox-api/get-mailbox-usage"}]},{"group":"Sync","pages":[{"title":"Get mailbox changes","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/changes","href":"/api/mailbox-api/get-mailbox-changes"},{"title":"Stream mailbox events","deprecated":null,"version":null,"openapi":"/openapi-app.json get /mailbox/events","href":"/api/mailbox-api/stream-mailbox-events"}]}]},{"tab":"Sending API","pages":[{"title":"Sending API","href":"/sending-api/introduction"}]}]},"basePath":"","title":"Get Mailbox connection - Qubrics","deploymentId":"dpl_2MqcLy8smQrrovUehgcZEsoo1tJX","buildId":"dpl_2MqcLy8smQrrovUehgcZEsoo1tJX","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DyP0AOE1.js","snippetPresets-CuYPAUIG.js","utils-ez5j6NBT.js","style-to-object-BY3JEAdk.js","utils-DG4aeUOF.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DFhcMUrP.js","conditional-requirements-CFM0id0Q.js","cloneDeep-ByDTqllG.js","_Uint8Array-CJ2WjX_H.js","isObject-FP1Yky1u.js","Page-CInwEL5w.js","CodeSnippet-CCk6UVRR.js","DynamicMarkdown-CU5QIokU.js","SectionHeading-BoT1NwPU.js","icon-MsvNhD56.js","ApiExamples-fyn9sMD9.js","usePlaygroundInputsStore-Bf0N_Y6L.js","shallow-CnU26VTn.js","isEqual-OWIKZzop.js","CodeSnippets-CZ9-M31v.js","getApiPlaygroundDisplay-BUw5JwZB.js","MethodPill-CC7p0-fp.js","getPastedJson-BOWYR2ND.js","DuplicateIcon-DOWJyC1b.js","createIcon-BsNyCaLY.js","axios-CsQoIw0U.js","Markdown-L0uigQE0.js","AssistantPageLink-Cur5OU4v.js","dist-CLdzWocy.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}