The paid plan, or null when the account is not subscribed. starter allows 100 new links per billing cycle; unlimited follows the trust ramp. Both include every feature — they differ only in volume.
Epoch ms. The window links_used and link_quota are measured over. Set only on the starter plan, where the allowance is per billing cycle; null means the quota is a lifetime total.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"kealink API","description":"Permanent link shortening and dynamic QR codes. A code we issue never stops resolving.","colors":{"primary":"#1f6f5c","light":"#4fbf9a","dark":"#14503f"},"favicon":"https://mintcdn.com/keabyte/Bn2vENqLv4JzwuSe/favicon.svg?fit=max\u0026auto=format\u0026n=Bn2vENqLv4JzwuSe\u0026q=85\u0026s=ecbaa562b546469e70ba13eb01ecbe24","navbar":{"links":[{"href":"https://kealinks.com/dashboard","label":"Dashboard"}],"primary":{"type":"button","label":"Get an API key","href":"https://kealinks.com/dashboard"}},"footer":{"socials":{"website":"https://kealinks.com"}},"seo":{"metatags":{"canonical":"https://docs.kealinks.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"keabyte","hasAudioNarration":false,"actualSubdomain":"keabyte","customDomains":["docs.kealinks.com"],"gitSource":{"type":"github","owner":"keabyte","repo":"kealink","deployBranch":"main","contentDirectory":"docs/api","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6a92f6837654e73a27bc02eb","collectionId":"263609c8-a0fa-4b42-a276-7b167f490bda","liveDeploymentHistoryId":"6a92f6837654e73a27bc02eb","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a92f6837654e73a27bc02eb","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API reference","count":24},{"language":"default","tag":"Guides","count":7},{"language":"default","tag":"Domains","count":4},{"language":"default","tag":"Links","count":4},{"language":"default","tag":"QR codes","count":4},{"language":"default","tag":"Team","count":4},{"language":"default","tag":"Get started","count":3},{"language":"default","tag":"Concepts","count":3},{"language":"default","tag":"Billing","count":3},{"language":"default","tag":"Meta","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","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":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/account/who-am-i-and-what-can-i-do","slug":"/api-reference/account/who-am-i-and-what-can-i-do","pageMetadata":{"title":"Who am I, and what can I do","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /api/account","href":"/api-reference/account/who-am-i-and-what-can-i-do","autogeneratedByOpenApi":true},"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":"Who am I, and what can I do","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /api/account","href":"/api-reference/account/who-am-i-and-what-can-i-do","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getAccount","summary":"Who am I, and what can I do","tags":["Account"],"security":["01620a98-d8f3-4f1e-919b-f723a0fb2fd8"],"responses":{"200":"1af861d9-7757-4f1e-9c37-f6645b44d06c","401":"e94b384e-89d0-48d6-8be7-36e409970aa3"},"method":"get","type":"path","servers":["a459eb3b-62a4-471d-afb1-fdbfc6c48075"],"path":"/api/account","baseUrlOptions":["https://api.kealinks.com"],"title":"Who am I, and what can I do","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"1af861d9-7757-4f1e-9c37-f6645b44d06c":{"description":"The account.","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","isRequired":true,"uniqueKey":"email","typeLabel":"string"},"status":{"type":"string","enum":["free","active","past_due","cancelled"],"description":"past_due is treated as active — a failed card is not abuse. cancelled cannot create or edit, but every link it ever made keeps resolving.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"plan":{"oneOf":[{"type":"string","description":"The paid plan, or null when the account is not subscribed. `starter` allows 100 new links per billing cycle; `unlimited` follows the trust ramp. Both include every feature — they differ only in volume.","enum":["starter","unlimited"],"isRequired":true,"uniqueKey":"plan.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The paid plan, or null when the account is not subscribed. `starter` allows 100 new links per billing cycle; `unlimited` follows the trust ramp. Both include every feature — they differ only in volume.","isRequired":true,"uniqueKey":"plan.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"plan","typeLabel":"enum\u003cstring> | null"},"links_used":{"type":"integer","description":"Counts archived links too. Archiving never refunds the quota. Measured over quota_period_start when that is set, otherwise over all time.","isRequired":true,"uniqueKey":"links_used","typeLabel":"integer"},"link_quota":{"oneOf":[{"type":"integer","description":"null means unbounded.","isRequired":true,"uniqueKey":"link_quota.oneOf.0","typeLabel":"integer"},{"type":"null","description":"null means unbounded.","isRequired":true,"uniqueKey":"link_quota.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"link_quota","typeLabel":"integer | null"},"quota_period_start":{"oneOf":[{"type":"integer","description":"Epoch ms. The window links_used and link_quota are measured over. Set only on the starter plan, where the allowance is per billing cycle; null means the quota is a lifetime total.","isRequired":true,"uniqueKey":"quota_period_start.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Epoch ms. The window links_used and link_quota are measured over. Set only on the starter plan, where the allowance is per billing cycle; null means the quota is a lifetime total.","isRequired":true,"uniqueKey":"quota_period_start.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"quota_period_start","typeLabel":"integer | null"},"can_create_link":{"type":"boolean","isRequired":true,"uniqueKey":"can_create_link","typeLabel":"boolean"},"can_use_domains":{"type":"boolean","isRequired":true,"uniqueKey":"can_use_domains","typeLabel":"boolean"},"can_see_analytics":{"type":"boolean","isRequired":true,"uniqueKey":"can_see_analytics","typeLabel":"boolean"},"trust":{"type":"object","properties":{"billing_cycles":{"type":"integer","description":"Renewed billing cycles observed. Each one doubles your link limit.","isRequired":true,"uniqueKey":"trust.billing_cycles","typeLabel":"integer"},"phone_verified":{"type":"boolean","description":"A verified mobile number is worth one more doubling.","isRequired":true,"uniqueKey":"trust.phone_verified","typeLabel":"boolean"}},"required":["billing_cycles","phone_verified"],"additionalProperties":false,"isRequired":true,"uniqueKey":"trust","typeLabel":"object"}},"required":["email","status","plan","links_used","link_quota","quota_period_start","can_create_link","can_use_domains","can_see_analytics","trust"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"email":"\u003cstring>","status":"free","plan":"starter","links_used":123,"link_quota":123,"quota_period_start":123,"can_create_link":true,"can_use_domains":true,"can_see_analytics":true,"trust":{"billing_cycles":123,"phone_verified":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"e94b384e-89d0-48d6-8be7-36e409970aa3":{"description":"Missing or invalid credentials.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"A sentence you can show a human. Never a code to switch on.","examples":["Your subscription is inactive. Existing links keep resolving."],"isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"additionalProperties":false,"description":"Every failure returns this shape with a real status code. 402 specifically means 'inactive subscription, existing links still work' — the message says so.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Your subscription is inactive. Existing links keep resolving."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"01620a98-d8f3-4f1e-919b-f723a0fb2fd8":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An API key (`klk_...`) or a Clerk session token. Both resolve to the same account and behave identically.","scopes":[]}}},"servers":{"a459eb3b-62a4-471d-afb1-fdbfc6c48075":{"url":"https://api.kealinks.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key (`klk_...`) or a Clerk session token. Both resolve to the same account and behave identically.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key (`klk_...`) or a Clerk session token. Both resolve to the same account and behave identically.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"keabyte","siteName":"kealink API","title":"Who am I, and what can I do - kealink API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-29T15:11:11.237Z","originalFileLocation":"api-reference/account/who-am-i-and-what-can-i-do.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=\"application-name\" content=\"kealink API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/keabyte/QUwpXtCaacj8gWV_/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/keabyte/QUwpXtCaacj8gWV_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/keabyte/QUwpXtCaacj8gWV_/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/keabyte/QUwpXtCaacj8gWV_/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/keabyte/QUwpXtCaacj8gWV_/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/keabyte/QUwpXtCaacj8gWV_/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/keabyte/QUwpXtCaacj8gWV_/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/keabyte/QUwpXtCaacj8gWV_/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/keabyte/QUwpXtCaacj8gWV_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Who am I, and what can I do - kealink API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"kealink API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.kealinks.com/api-reference/account/who-am-i-and-what-can-i-do\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://keabyte.mintlify.app/_mintlify/api/og/v2?division=Account\u0026amp;title=Who+am+I%2C+and+what+can+I+do\u0026amp;theme=5e2df7c23cac04fb33eba183\u0026amp;signature=f805c7bd4765b05cadb3d2252357a75e9c52a10baaf51431eb1813eff26601aa\">\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=\"Who am I, and what can I do - kealink API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://keabyte.mintlify.app/_mintlify/api/og/v2?division=Account\u0026amp;title=Who+am+I%2C+and+what+can+I+do\u0026amp;theme=5e2df7c23cac04fb33eba183\u0026amp;signature=f805c7bd4765b05cadb3d2252357a75e9c52a10baaf51431eb1813eff26601aa\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/keabyte/QUwpXtCaacj8gWV_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"kealink API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1f6f5c\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.kealinks.com/api-reference/account/who-am-i-and-what-can-i-do\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/account/who-am-i-and-what-can-i-do.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.kealinks.com/#organization\",\"name\":\"kealink API\",\"url\":\"https://docs.kealinks.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.kealinks.com#website\",\"name\":\"kealink API\",\"url\":\"https://docs.kealinks.com\",\"publisher\":{\"@id\":\"https://docs.kealinks.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.kealinks.com/api-reference/account/who-am-i-and-what-can-i-do#webpage\",\"url\":\"https://docs.kealinks.com/api-reference/account/who-am-i-and-what-can-i-do\",\"name\":\"Who am I, and what can I do\",\"dateModified\":\"2026-08-29T15:11:11.237Z\",\"isPartOf\":{\"@id\":\"https://docs.kealinks.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.kealinks.com/api-reference/account/who-am-i-and-what-can-i-do#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.kealinks.com/api-reference/account/who-am-i-and-what-can-i-do#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"kealink API\",\"item\":\"https://docs.kealinks.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Who am I, and what can I do\",\"item\":\"https://docs.kealinks.com/api-reference/account/who-am-i-and-what-can-i-do\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.kealinks.com/api-reference/account/who-am-i-and-what-can-i-do#apireference\",\"headline\":\"Who am I, and what can I do\",\"name\":\"Who am I, and what can I do\",\"url\":\"https://docs.kealinks.com/api-reference/account/who-am-i-and-what-can-i-do\",\"mainEntityOfPage\":{\"@id\":\"https://docs.kealinks.com/api-reference/account/who-am-i-and-what-can-i-do#webpage\"},\"dateModified\":\"2026-08-29T15:11:11.237Z\",\"publisher\":{\"@id\":\"https://docs.kealinks.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.kealinks.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"kealink API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"kealink API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Meta","pages":[{"title":"Liveness check","deprecated":null,"version":null,"openapi":"/openapi.json get /health","href":"/api-reference/meta/liveness-check"},{"title":"This document","deprecated":null,"version":null,"openapi":"/openapi.json get /api/openapi.json","href":"/api-reference/meta/this-document"}]},{"group":"Machine payments","pages":[{"title":"What an agent can buy","deprecated":null,"version":null,"openapi":"/openapi.json get /api/pricing","href":"/api-reference/machine-payments/what-an-agent-can-buy"}]},{"group":"Links","pages":[{"title":"List links","deprecated":null,"version":null,"openapi":"/openapi.json get /api/links","href":"/api-reference/links/list-links"},{"title":"Create a permanent link","deprecated":null,"version":null,"openapi":"/openapi.json post /api/links","href":"/api-reference/links/create-a-permanent-link"},{"title":"Repoint a link","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/links/{id}","href":"/api-reference/links/repoint-a-link"},{"title":"Archive a link","deprecated":null,"version":null,"openapi":"/openapi.json post /api/links/{id}/archive","href":"/api-reference/links/archive-a-link"}]},{"group":"QR codes","pages":[{"title":"Download QR artwork","deprecated":null,"version":null,"openapi":"/openapi.json get /api/links/{id}/qr","href":"/api-reference/qr-codes/download-qr-artwork"},{"title":"Download the stored centre logo","deprecated":null,"version":null,"openapi":"/openapi.json get /api/links/{id}/logo","href":"/api-reference/qr-codes/download-the-stored-centre-logo"},{"title":"Upload a centre logo","deprecated":null,"version":null,"openapi":"/openapi.json post /api/links/{id}/logo","href":"/api-reference/qr-codes/upload-a-centre-logo"},{"title":"Remove the centre logo","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/links/{id}/logo","href":"/api-reference/qr-codes/remove-the-centre-logo"}]},{"group":"Analytics","pages":[{"title":"Scan and click analytics","description":"Defaults to the last 30 days grouped by day. Needs a live subscription.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/links/{id}/stats","href":"/api-reference/analytics/scan-and-click-analytics"}]},{"group":"Account","pages":[{"title":"Who am I, and what can I do","deprecated":null,"version":null,"openapi":"/openapi.json get /api/account","href":"/api-reference/account/who-am-i-and-what-can-i-do"}]},{"group":"Billing","pages":[{"title":"Start a subscription","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json post /api/billing/checkout","href":"/api-reference/billing/start-a-subscription"},{"title":"Mint this account's API key","deprecated":null,"version":null,"openapi":"/openapi.json post /api/billing/claim","href":"/api-reference/billing/mint-this-accounts-api-key"},{"title":"Open the billing portal","deprecated":null,"version":null,"openapi":"/openapi.json post /api/billing/portal","href":"/api-reference/billing/open-the-billing-portal"}]},{"group":"Domains","pages":[{"title":"List custom domains","deprecated":null,"version":null,"openapi":"/openapi.json get /api/domains","href":"/api-reference/domains/list-custom-domains"},{"title":"Register a custom domain","deprecated":null,"version":null,"openapi":"/openapi.json post /api/domains","href":"/api-reference/domains/register-a-custom-domain"},{"title":"Check a domain's validation state","deprecated":null,"version":null,"openapi":"/openapi.json get /api/domains/{id}","href":"/api-reference/domains/check-a-domains-validation-state"},{"title":"Remove a custom domain","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/domains/{id}","href":"/api-reference/domains/remove-a-custom-domain"}]},{"group":"Team","pages":[{"title":"Workspaces this sign-in can reach","deprecated":null,"version":null,"openapi":"/openapi.json get /api/workspaces","href":"/api-reference/team/workspaces-this-sign-in-can-reach"},{"title":"List workspace members","deprecated":null,"version":null,"openapi":"/openapi.json get /api/members","href":"/api-reference/team/list-workspace-members"},{"title":"Invite a teammate","deprecated":null,"version":null,"openapi":"/openapi.json post /api/members","href":"/api-reference/team/invite-a-teammate"},{"title":"Remove a teammate","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/members/{id}","href":"/api-reference/team/remove-a-teammate"}]}]}]},"title":"Who am I, and what can I do - kealink API","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}