Returns the key or app connection used for this request: its scopes, and which teams and forms it can access. Handy to check what a credential is allowed to do.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"formcarry","colors":{"primary":"#517df4","light":"#95c9f5","dark":"#040404"},"logo":{"light":"https://mintcdn.com/formcarry/-_LlBOLzZQv8iNf2/images/formcarry_normal.svg?fit=max\u0026auto=format\u0026n=-_LlBOLzZQv8iNf2\u0026q=85\u0026s=3480541c1c8184b2f6478567a35ff336","dark":"https://mintcdn.com/formcarry/-_LlBOLzZQv8iNf2/images/formcarry_pure_white.svg?fit=max\u0026auto=format\u0026n=-_LlBOLzZQv8iNf2\u0026q=85\u0026s=87cc9d8e1ea902705fc28452a268cf72","href":"https://formcarry.com"},"favicon":{"light":"https://mintcdn.com/formcarry/OjwJjkTEy_KHxqvS/images/favicon-32x32.png?fit=max\u0026auto=format\u0026n=OjwJjkTEy_KHxqvS\u0026q=85\u0026s=2f9fe9658b61fb2733291ac87e05f707","dark":"https://mintcdn.com/formcarry/OjwJjkTEy_KHxqvS/images/favicon-32x32.png?fit=max\u0026auto=format\u0026n=OjwJjkTEy_KHxqvS\u0026q=85\u0026s=2f9fe9658b61fb2733291ac87e05f707"},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://app.formcarry.com"}},"footer":{"socials":{"website":"https://formcarry.com"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"formcarry","hasAudioNarration":false,"actualSubdomain":"formcarry","customDomains":["formcarry.com"],"gitSource":{"type":"github","owner":"nusu","repo":"formcarry-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ab83fb330d2120626de173a","collectionId":"da951cec-d927-4b06-ab14-4e0832084f25","liveDeploymentHistoryId":"6ab83fb330d2120626de173a","schemaVersion":"v3"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ab83fb330d2120626de173a","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"Documentation","count":35},{"language":"default","tag":"API Reference","count":34},{"language":"default","tag":"Endpoints","count":28},{"language":"default","tag":"forms","count":18},{"language":"default","tag":"submissions","count":8},{"language":"default","tag":"Features","count":7},{"language":"default","tag":"Frameworks","count":7},{"language":"default","tag":"Build with AI","count":6},{"language":"default","tag":"Site builders","count":5},{"language":"default","tag":"Legacy API","count":4}]},"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":"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":"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":"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":"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":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".platform-logo{display:inline-block;margin:0;width:22px;height:22px}.dark .platform-logo-dark{filter:invert(1)}"}],"page":{"pagePath":"api-reference/me/retrieve-the-current-key-or-connection","slug":"/api-reference/me/retrieve-the-current-key-or-connection","pageMetadata":{"title":"Retrieve the current key or connection","description":"Returns the key or app connection used for this request: its scopes, and which teams and forms it can access. Handy to check what a credential is allowed to do.","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json get /v1/me","href":"/api-reference/me/retrieve-the-current-key-or-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: \"Returns the key or app connection used for this request: its scopes, and which teams and forms it can access. Handy to check what a credential is allowed to do.\"\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":"Retrieve the current key or connection","description":"Returns the key or app connection used for this request: its scopes, and which teams and forms it can access. Handy to check what a credential is allowed to do.","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json get /v1/me","href":"/api-reference/me/retrieve-the-current-key-or-connection","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"MeController_me","summary":"Retrieve the current key or connection","description":"Returns the key or app connection used for this request: its scopes, and which teams and forms it can access. Handy to check what a credential is allowed to do.","parameters":[],"responses":{"200":"cf4a8b31-c2db-4474-931b-57af3b572e77","401":"11e39aa4-9a48-475b-ab7a-b152a8ce44ca","403":"30b6a54c-68e5-452d-9804-950867a7ab34","429":"2e8fec97-0d40-40a5-8d3d-e63a25eab421"},"tags":["me"],"security":["de2672a5-4035-4ae8-b33c-fe03c7b6226e"],"method":"get","type":"path","servers":["a3c1387d-dbef-4745-a566-37fbc9ae46a1"],"path":"/v1/me","baseUrlOptions":["https://api.formcarry.com"],"title":"Retrieve the current key or connection","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"cf4a8b31-c2db-4474-931b-57af3b572e77":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["key","app"],"description":"key: an API key; app: an OAuth connection","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"key":{"oneOf":[{"type":"object","required":["id","name","prefix","last4","kind"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"key.oneOf.0.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"key.oneOf.0.name","typeLabel":"string"},"prefix":{"type":"string","example":"fc_live_1pcvCQca","isRequired":true,"uniqueKey":"key.oneOf.0.prefix","typeLabel":"string"},"last4":{"type":"string","isRequired":true,"uniqueKey":"key.oneOf.0.last4","typeLabel":"string"},"kind":{"type":"string","enum":["standard","legacy"],"description":"standard: made on the API keys page. legacy: the team's original key, kept working under the same secret.","isRequired":true,"uniqueKey":"key.oneOf.0.kind","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"key.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"key.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"key","typeLabel":"object | null"},"app":{"oneOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"OAuth client id","isRequired":true,"uniqueKey":"app.oneOf.0.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"app.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"app.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"app.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"app","typeLabel":"object | null"},"scopes":{"description":"Union of the per-team scopes","type":"array","items":{"type":"string","uniqueKey":"scopes.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"scopes","typeLabel":"string[]"},"teams":{"description":"Every team this credential can act on, with its own scopes","type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"teams.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"teams.items.[INDEX].name","typeLabel":"string"},"scopes":{"example":["forms:read","submissions:read"],"type":"array","items":{"type":"string","uniqueKey":"teams.items.[INDEX].scopes.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"teams.items.[INDEX].scopes","typeLabel":"string[]"},"form_access":{"type":"object","properties":{"mode":{"type":"string","enum":["all","list"],"description":"all: every form of the team. list: only the forms listed in forms.","isRequired":true,"uniqueKey":"teams.items.[INDEX].form_access.mode","typeLabel":"enum\u003cstring>"},"forms":{"description":"The forms this key is limited to, when mode is list","type":"array","items":{"type":"string","uniqueKey":"teams.items.[INDEX].form_access.forms.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"teams.items.[INDEX].form_access.forms","typeLabel":"string[]"}},"required":["mode","forms"],"isRequired":true,"uniqueKey":"teams.items.[INDEX].form_access","typeLabel":"object"}},"required":["id","name","scopes","form_access"],"uniqueKey":"teams.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"teams","typeLabel":"object[]"}},"required":["type","key","app","scopes","teams"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"key","key":{"id":"\u003cstring>","name":"\u003cstring>","prefix":"fc_live_1pcvCQca","last4":"\u003cstring>","kind":"standard"},"app":{"id":"\u003cstring>","name":"\u003cstring>"},"scopes":["\u003cstring>"],"teams":[{"id":"\u003cstring>","name":"\u003cstring>","scopes":["forms:read","submissions:read"],"form_access":{"mode":"all","forms":["\u003cstring>"]}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"11e39aa4-9a48-475b-ab7a-b152a8ce44ca":{"description":"The request carried no usable key or token.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["authentication_error","permission_error","invalid_request_error","rate_limit_error","api_error"],"example":"invalid_request_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","example":"invalid_parameter","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"limit must not be greater than 100","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Echoes X-Request-Id. Quote it when contacting support.","example":"2f9c1a7e-5b31-4d2e-9c0a-8e7f6d5c4b3a","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"param":{"type":"string","description":"The offending parameter, when there is one","example":"limit","uniqueKey":"error.param","typeLabel":"string"},"required":{"description":"On insufficient_scope: the scopes the request needs. Reissue the key with them.","example":["submissions:write"],"type":"array","items":{"type":"string","uniqueKey":"error.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.required","typeLabel":"string[]"},"retry_after":{"type":"number","description":"On scan_concurrency: seconds to wait before trying again.","example":2,"uniqueKey":"error.retry_after","typeLabel":"number"}},"required":["type","code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"missing_bearer":{"title":"missing_bearer","value":{"error":{"type":"authentication_error","code":"missing_bearer","message":"Send your key as \"Authorization: Bearer fc_live_...\" on every request.","request_id":"2f9c1a7e-5b31-4d2e-9c0a-8e7f6d5c4b3a"}}},"invalid_key":{"title":"invalid_key","value":{"error":{"type":"authentication_error","code":"invalid_key","message":"This API key or access token is unknown, revoked or expired.","request_id":"2f9c1a7e-5b31-4d2e-9c0a-8e7f6d5c4b3a"}}},"wrong_audience":{"title":"wrong_audience","value":{"error":{"type":"authentication_error","code":"wrong_audience","message":"This access token was issued for a different resource. Authorize again for this server.","request_id":"2f9c1a7e-5b31-4d2e-9c0a-8e7f6d5c4b3a"}}}},"exampleType":"examples"}},"exampleType":"examples"},"30b6a54c-68e5-452d-9804-950867a7ab34":{"description":"The key is valid but may not do this.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["authentication_error","permission_error","invalid_request_error","rate_limit_error","api_error"],"example":"invalid_request_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","example":"invalid_parameter","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"limit must not be greater than 100","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Echoes X-Request-Id. Quote it when contacting support.","example":"2f9c1a7e-5b31-4d2e-9c0a-8e7f6d5c4b3a","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"param":{"type":"string","description":"The offending parameter, when there is one","example":"limit","uniqueKey":"error.param","typeLabel":"string"},"required":{"description":"On insufficient_scope: the scopes the request needs. Reissue the key with them.","example":["submissions:write"],"type":"array","items":{"type":"string","uniqueKey":"error.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.required","typeLabel":"string[]"},"retry_after":{"type":"number","description":"On scan_concurrency: seconds to wait before trying again.","example":2,"uniqueKey":"error.retry_after","typeLabel":"number"}},"required":["type","code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"insufficient_scope":{"title":"insufficient_scope","value":{"error":{"type":"permission_error","code":"insufficient_scope","message":"This key is missing the submissions:write scope.","required":["submissions:write"],"request_id":"2f9c1a7e-5b31-4d2e-9c0a-8e7f6d5c4b3a"}}},"form_access_restricted":{"title":"form_access_restricted","value":{"error":{"type":"permission_error","code":"form_access_restricted","message":"This key is restricted to specific forms and cannot create new ones.","request_id":"2f9c1a7e-5b31-4d2e-9c0a-8e7f6d5c4b3a"}}},"team_inactive":{"title":"team_inactive","value":{"error":{"type":"permission_error","code":"team_inactive","message":"The team that owns this key is not active.","request_id":"2f9c1a7e-5b31-4d2e-9c0a-8e7f6d5c4b3a"}}},"owner_unverified":{"title":"owner_unverified","value":{"error":{"type":"permission_error","code":"owner_unverified","message":"The team owner must verify their email address before the API can be used.","request_id":"2f9c1a7e-5b31-4d2e-9c0a-8e7f6d5c4b3a"}}}},"exampleType":"examples"}},"exampleType":"examples"},"2e8fec97-0d40-40a5-8d3d-e63a25eab421":{"description":"Slow down and retry after the Retry-After header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["authentication_error","permission_error","invalid_request_error","rate_limit_error","api_error"],"example":"invalid_request_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","example":"invalid_parameter","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"limit must not be greater than 100","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Echoes X-Request-Id. Quote it when contacting support.","example":"2f9c1a7e-5b31-4d2e-9c0a-8e7f6d5c4b3a","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"param":{"type":"string","description":"The offending parameter, when there is one","example":"limit","uniqueKey":"error.param","typeLabel":"string"},"required":{"description":"On insufficient_scope: the scopes the request needs. Reissue the key with them.","example":["submissions:write"],"type":"array","items":{"type":"string","uniqueKey":"error.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.required","typeLabel":"string[]"},"retry_after":{"type":"number","description":"On scan_concurrency: seconds to wait before trying again.","example":2,"uniqueKey":"error.retry_after","typeLabel":"number"}},"required":["type","code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"rate_limited":{"title":"rate_limited","value":{"error":{"type":"rate_limit_error","code":"rate_limited","message":"Too many requests.","request_id":"2f9c1a7e-5b31-4d2e-9c0a-8e7f6d5c4b3a"}}},"scan_concurrency":{"title":"scan_concurrency","value":{"error":{"type":"rate_limit_error","code":"scan_concurrency","message":"At most 2 filtered submission requests may run at once per key. Wait for the running ones to finish.","request_id":"2f9c1a7e-5b31-4d2e-9c0a-8e7f6d5c4b3a"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"de2672a5-4035-4ae8-b33c-fe03c7b6226e":{"api_key":{"scheme":"bearer","bearerFormat":"fc_live_...","type":"http","scopes":[]}}},"servers":{"a3c1387d-dbef-4745-a566-37fbc9ae46a1":{"url":"https://api.formcarry.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"fc_live_...","type":"http","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"api_key","name":"Authorization"}],"title":"api_key"}]},"originalFileLocation":"https://api.formcarry.com/docs-json"},"subdomain":"formcarry","siteName":"formcarry","title":"Retrieve the current key or connection - formcarry","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-26T21:44:40.952Z","originalFileLocation":"api-reference/me/retrieve-the-current-key-or-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 the key or app connection used for this request: its scopes, and which teams and forms it can access. Handy to check what a credential is allowed to do.\">\u003cmeta data-mint-head name=\"application-name\" content=\"formcarry\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/formcarry/xlaNeRgCZMMRbwye/_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=\"/docs/mintlify-assets/_mintlify/favicons/formcarry/xlaNeRgCZMMRbwye/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/formcarry/xlaNeRgCZMMRbwye/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/formcarry/xlaNeRgCZMMRbwye/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/formcarry/xlaNeRgCZMMRbwye/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/formcarry/xlaNeRgCZMMRbwye/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/formcarry/xlaNeRgCZMMRbwye/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/formcarry/xlaNeRgCZMMRbwye/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/formcarry/xlaNeRgCZMMRbwye/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve the current key or connection - formcarry\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the key or app connection used for this request: its scopes, and which teams and forms it can access. Handy to check what a credential is allowed to do.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"formcarry\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://formcarry.com/docs/api-reference/me/retrieve-the-current-key-or-connection\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://formcarry.mintlify.site/docs/_mintlify/api/og/v2?division=me\u0026amp;title=Retrieve+the+current+key+or+connection\u0026amp;description=Returns+the+key+or+app+connection+used+for+this+request%3A+its+scopes%2C+and+which+teams+and+forms+it+can+access.+Handy+to+check+what+a+credential+is+allowed+to+do.\u0026amp;theme=e43aeaeb39ccdad3f7790346\u0026amp;signature=67d6434f60590df36cf5499f8edc471e570679cde98667d2c34317499346b012\">\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=\"Retrieve the current key or connection - formcarry\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the key or app connection used for this request: its scopes, and which teams and forms it can access. Handy to check what a credential is allowed to do.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://formcarry.mintlify.site/docs/_mintlify/api/og/v2?division=me\u0026amp;title=Retrieve+the+current+key+or+connection\u0026amp;description=Returns+the+key+or+app+connection+used+for+this+request%3A+its+scopes%2C+and+which+teams+and+forms+it+can+access.+Handy+to+check+what+a+credential+is+allowed+to+do.\u0026amp;theme=e43aeaeb39ccdad3f7790346\u0026amp;signature=67d6434f60590df36cf5499f8edc471e570679cde98667d2c34317499346b012\">\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=\"/docs/mintlify-assets/_mintlify/favicons/formcarry/xlaNeRgCZMMRbwye/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"formcarry\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#517df4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://formcarry.com/docs/api-reference/me/retrieve-the-current-key-or-connection\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/me/retrieve-the-current-key-or-connection.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://formcarry.com/#organization\",\"name\":\"formcarry\",\"url\":\"https://formcarry.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/formcarry/-_LlBOLzZQv8iNf2/images/formcarry_normal.svg?fit=max\u0026auto=format\u0026n=-_LlBOLzZQv8iNf2\u0026q=85\u0026s=3480541c1c8184b2f6478567a35ff336\"}},{\"@type\":\"WebSite\",\"@id\":\"https://formcarry.com/docs#website\",\"name\":\"formcarry\",\"url\":\"https://formcarry.com/docs\",\"publisher\":{\"@id\":\"https://formcarry.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://formcarry.com/docs/api-reference/me/retrieve-the-current-key-or-connection#webpage\",\"url\":\"https://formcarry.com/docs/api-reference/me/retrieve-the-current-key-or-connection\",\"name\":\"Retrieve the current key or connection\",\"description\":\"Returns the key or app connection used for this request: its scopes, and which teams and forms it can access. Handy to check what a credential is allowed to do.\",\"dateModified\":\"2026-09-26T21:44:40.952Z\",\"isPartOf\":{\"@id\":\"https://formcarry.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://formcarry.com/docs/api-reference/me/retrieve-the-current-key-or-connection#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://formcarry.com/docs/api-reference/me/retrieve-the-current-key-or-connection#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://formcarry.com/docs/api-reference/forms/list-forms\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve the current key or connection\",\"item\":\"https://formcarry.com/docs/api-reference/me/retrieve-the-current-key-or-connection\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://formcarry.com/docs/api-reference/me/retrieve-the-current-key-or-connection#apireference\",\"headline\":\"Retrieve the current key or connection\",\"name\":\"Retrieve the current key or connection\",\"description\":\"Returns the key or app connection used for this request: its scopes, and which teams and forms it can access. Handy to check what a credential is allowed to do.\",\"url\":\"https://formcarry.com/docs/api-reference/me/retrieve-the-current-key-or-connection\",\"mainEntityOfPage\":{\"@id\":\"https://formcarry.com/docs/api-reference/me/retrieve-the-current-key-or-connection#webpage\"},\"dateModified\":\"2026-09-26T21:44:40.952Z\",\"publisher\":{\"@id\":\"https://formcarry.com/#organization\"},\"isPartOf\":{\"@id\":\"https://formcarry.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"formcarry\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"formcarry","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Formcarry API Overview","sidebarTitle":"Overview","href":"/api/overview"},{"title":"API Authentication with Bearer Tokens","sidebarTitle":"Authentication","href":"/api/authentication"}]},{"group":"Endpoints","pages":[{"group":"forms","pages":[{"title":"List forms","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json get /v1/forms","href":"/api-reference/forms/list-forms"},{"title":"Create a form","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json post /v1/forms","href":"/api-reference/forms/create-a-form"},{"title":"Retrieve a form","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json get /v1/forms/{form_id}","href":"/api-reference/forms/retrieve-a-form"},{"title":"Delete a form","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json delete /v1/forms/{form_id}","href":"/api-reference/forms/delete-a-form"},{"title":"Update a form","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json patch /v1/forms/{form_id}","href":"/api-reference/forms/update-a-form"},{"title":"Add a recipient","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json post /v1/forms/{form_id}/self-email-notification/recipients","href":"/api-reference/forms/add-a-recipient"},{"title":"Remove a recipient","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json delete /v1/forms/{form_id}/self-email-notification/recipients/{email}","href":"/api-reference/forms/remove-a-recipient"},{"title":"Upload an image","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json post /v1/forms/{form_id}/images","href":"/api-reference/forms/upload-an-image"},{"title":"List a form's fields","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json get /v1/forms/{form_id}/fields","href":"/api-reference/forms/list-a-forms-fields"},{"title":"List webhooks","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json get /v1/forms/{form_id}/webhooks","href":"/api-reference/forms/list-webhooks"},{"title":"Add a webhook","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json post /v1/forms/{form_id}/webhooks","href":"/api-reference/forms/add-a-webhook"},{"title":"Retrieve a webhook","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json get /v1/forms/{form_id}/webhooks/{webhook_id}","href":"/api-reference/forms/retrieve-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json delete /v1/forms/{form_id}/webhooks/{webhook_id}","href":"/api-reference/forms/delete-a-webhook"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json patch /v1/forms/{form_id}/webhooks/{webhook_id}","href":"/api-reference/forms/update-a-webhook"},{"title":"List deliveries","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json get /v1/forms/{form_id}/webhooks/{webhook_id}/deliveries","href":"/api-reference/forms/list-deliveries"},{"title":"Retrieve a delivery","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json get /v1/forms/{form_id}/webhooks/{webhook_id}/deliveries/{submission_id}","href":"/api-reference/forms/retrieve-a-delivery"},{"title":"Send a submission again","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json post /v1/forms/{form_id}/webhooks/{webhook_id}/deliveries/{submission_id}/redeliver","href":"/api-reference/forms/send-a-submission-again"},{"title":"List email servers","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json get /v1/email-servers","href":"/api-reference/forms/list-email-servers"}]},{"group":"submissions","pages":[{"title":"List submissions","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json get /v1/forms/{form_id}/submissions","href":"/api-reference/submissions/list-submissions"},{"title":"Count submissions","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json get /v1/forms/{form_id}/submissions/summary","href":"/api-reference/submissions/count-submissions"},{"title":"Read what happened to submissions","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json get /v1/forms/{form_id}/submissions/deliveries","href":"/api-reference/submissions/read-what-happened-to-submissions"},{"title":"Retrieve a submission","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json get /v1/forms/{form_id}/submissions/{submission_id}","href":"/api-reference/submissions/retrieve-a-submission"},{"title":"Delete a submission","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json delete /v1/forms/{form_id}/submissions/{submission_id}","href":"/api-reference/submissions/delete-a-submission"},{"title":"Mark a submission as spam","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json post /v1/forms/{form_id}/submissions/{submission_id}/spam","href":"/api-reference/submissions/mark-a-submission-as-spam"},{"title":"Restore a submission from spam","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json post /v1/forms/{form_id}/submissions/{submission_id}/restore","href":"/api-reference/submissions/restore-a-submission-from-spam"},{"title":"Search submissions across forms","description":"Searches the 25 most recently active forms this key can read and returns the matches with the form each one came from.\n\nTakes the same filters as a form's own list. Matches come grouped by form, and the response carries `complete: false` when the search did not reach every form or every match; narrow it with form_ids, team_id or a date range.\n\nFor one form, use its own list, which pages through everything with a cursor.","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json get /v1/submissions","href":"/api-reference/submissions/search-submissions-across-forms"}]},{"group":"me","pages":[{"title":"Retrieve the current key or connection","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json get /v1/me","href":"/api-reference/me/retrieve-the-current-key-or-connection"}]},{"group":"health","pages":[{"title":"Check that the API is up","description":"No authentication needed.","deprecated":null,"version":null,"openapi":"https://api.formcarry.com/docs-json get /v1/health","href":"/api-reference/health/check-that-the-api-is-up"}]}]},{"group":"Legacy API","pages":[{"title":"Legacy Formcarry API Overview","sidebarTitle":"Overview","href":"/api/legacy/overview"},{"title":"Legacy API Authentication","sidebarTitle":"Authentication","href":"/api/legacy/authentication"},{"title":"Legacy Forms API — Create and Delete Forms","sidebarTitle":"Forms","href":"/api/legacy/forms"},{"title":"Legacy Submissions API — List and Filter Submissions","sidebarTitle":"Submissions","href":"/api/legacy/submissions"}]}]}]},"basePath":"","title":"Retrieve the current key or connection - formcarry","buildId":"dpl_CEsowfH15TDzsBT2BFbX312Be4Ct","deploymentId":"dpl_CEsowfH15TDzsBT2BFbX312Be4Ct","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CqF8gK93.js","utils-Cfy66YIG.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-cadwlSiW.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BOSHrB55.js","snippetPresets-DuIJ6Tui.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CGry0O4L.js","ApiExamples-BByZ-4eP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DWD4BnjW.js","shallow-Bo7p10ck.js","getApiPlaygroundDisplay-C7mFZ2Cg.js","CodeSnippet-DrT8v8gt.js","CodeSnippets-DGLmtlSm.js","getPastedJson-DXZGgv-T.js","icon-DMjuBky8.js","MethodPill-C_c9VvF7.js","DuplicateIcon-D8Zrb3hW.js","createIcon-eYWxX-Sl.js","DynamicMarkdown-DORtg_Te.js","SectionHeading-DE1W9Ett.js","axios-vUo_bRtp.js","Markdown-BvSqw8zR.js","clsx-B-KWekQe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CTE3eEYy.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ba-QebqG.js"]}