What each scope grants, how to request scopes for OAuth tokens and what the API returns when a required scope is missing.
Scopes control what your credential can access. Each endpoint requires a specific scope. If your credential doesn’t carry it, the API returns 403 Forbidden. It never returns partial data or silently omits fields. Designing around scopes from the start keeps your integration predictable and limits the blast radius if a token leaks.
Available scopes
Scope
Required for
Grants
Plan
profile.read
GET /profile
Public profile, username and plan
Free
services.read
GET /services, GET /services/{id}
Your default and single-use services
Free
services.write
POST /services, PATCH /services/{id}, DELETE /services/{id}
Create, edit and delete your services and single-use links
Free
availability.read
GET /availability
Available time slots
Free
bookings.read
GET /bookings, GET /bookings/{id}
Existing bookings
Free
webhooks.read
GET /webhooks, GET /webhooks/{id}
The webhooks this credential set up
Pro
webhooks.write
POST /webhooks, PATCH /webhooks/{id}, DELETE /webhooks/{id}
Send your booking updates to a URL. Creating and editing also need bookings.read
Pro
Plans
What a credential can do depends on the plan of the Tikk account it belongs to, not on the developer who built the app. Reading and managing your data works on every plan. Pro is for automation: webhooks.
Free scopes work on every plan.
Pro scopes can be granted on any plan, but only work while the account is on Tikk Pro. Calls from a Free account return 403 with "error": "plan_required". See Errors.
Nothing needs to be reconnected or reissued when the plan changes. After an upgrade the same credential works immediately. After a downgrade, Pro calls return plan_required again and webhooks pause.
The API also follows the account’s plan limits: creating a service beyond the Free limit returns the same plan_required error, just like it would be refused in the app.To adapt your UI up front, read plan from GET /profile.
API keys
When you create a key under Settings → API Keys, you choose which scopes it carries. Pick at least one. A key can only call endpoints for the scopes you gave it. You can have up to 10 active keys.
OAuth tokens
When building a partner app, request only the scopes your integration actually needs. You choose your app’s scopes when you register it in the developer portal. Specify them in the scope query parameter on the authorization URL as a space-separated list:
The user sees exactly which scopes your app is requesting on Tikk’s consent screen. The resulting access token only carries the scopes you requested, even if the user’s account has broader permissions.
Missing scope response
If you call an endpoint without the required scope, the API responds with 403 Forbidden and the following body:
scopes lists the scope or scopes the endpoint needs. A credential that holds them but belongs to a Free account gets plan_required instead on Pro endpoints. Check the Errors page for the full list of error codes and their meanings.
Request the minimum scopes your integration needs. Fewer scopes means smaller
impact if a token leaks. An attacker with a profile.read-only token can’t
reach bookings data or change your services.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Tikk","colors":{"primary":"#848484","light":"#151515","dark":"#cbcbcb"},"logo":{"light":"https://mintcdn.com/tikk/V1Cxv-mnTLJxEuos/images/logo.svg?fit=max\u0026auto=format\u0026n=V1Cxv-mnTLJxEuos\u0026q=85\u0026s=3c872a88f73e2a482351b0af4a8f9664","dark":"https://mintcdn.com/tikk/V1Cxv-mnTLJxEuos/images/logo-white.svg?fit=max\u0026auto=format\u0026n=V1Cxv-mnTLJxEuos\u0026q=85\u0026s=0bb9108d1260f6cdbbe3adb03c6bdd42"},"favicon":{"light":"https://mintcdn.com/tikk/V1Cxv-mnTLJxEuos/images/logo-icon2.svg?fit=max\u0026auto=format\u0026n=V1Cxv-mnTLJxEuos\u0026q=85\u0026s=969244754da700eeec1d0ffe5983dedc","dark":"https://mintcdn.com/tikk/V1Cxv-mnTLJxEuos/images/logo-icon2.svg?fit=max\u0026auto=format\u0026n=V1Cxv-mnTLJxEuos\u0026q=85\u0026s=969244754da700eeec1d0ffe5983dedc"},"api":{"playground":{"display":"interactive"},"examples":{"languages":["bash","javascript","python","php"]}},"appearance":{"default":"light","strict":true},"background":{"decoration":"grid"},"navbar":{"links":[{"href":"https://developer.tikk.chat","label":"Developer portal"}],"primary":{"type":"button","label":"Get Started Free","href":"https://app.tikk.chat/register"}},"footer":{"socials":{"website":"https://tikk.chat","linkedin":"https://www.linkedin.com/company/111278956"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"section","latex":false},"integrations":{"posthog":{"apiKey":"phc_pC7W69jal6F4Dq8c20pId4jqyuaLa4JcdNqH631vEQ","apiHost":"https://p.tikk.chat","sessionRecording":true}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tikk","hasAudioNarration":false,"actualSubdomain":"tikk","customDomains":["docs.tikk.chat"],"gitSource":{"type":"github","owner":"whitespacecode","repo":"tikk-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6af6e9cd29222d23132a6c7f","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"Documentation","count":22},{"language":"default","tag":"API Reference","count":19},{"language":"default","tag":"Guides","count":12},{"language":"default","tag":"Webhooks","count":6},{"language":"default","tag":"Services","count":5},{"language":"default","tag":"Overview","count":4},{"language":"default","tag":"Core Concepts","count":4},{"language":"default","tag":"Get Started","count":3},{"language":"default","tag":"Bookings","count":2},{"language":"default","tag":"Plans \u0026 Billing","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":"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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#topbar-cta-button span.bg-primary-dark{background:#000!important}img[alt~=\"logo\"]{height:40px!important}"}],"page":{"pagePath":"api-reference/scopes","slug":"/api-reference/scopes","pageMetadata":{"title":"API scopes. Access permissions for each endpoint","sidebarTitle":"Scopes","description":"What each scope grants, how to request scopes for OAuth tokens and what the API returns when a required scope is missing.","href":"/api-reference/scopes"},"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: \"What each scope grants, how to request scopes for OAuth tokens and what the API returns when a required scope is missing.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Scopes control what your credential can access. Each endpoint requires a specific scope. If your credential doesn’t carry it, the API returns `,_jsx(_components.code,{children:`403 Forbidden`}),`. It never returns partial data or silently omits fields. Designing around scopes from the start keeps your integration predictable and limits the blast radius if a token leaks.`]}),`\n`,_jsx(Heading,{level:`2`,id:`available-scopes`,children:`Available scopes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Scope`}),_jsx(_components.th,{children:`Required for`}),_jsx(_components.th,{children:`Grants`}),_jsx(_components.th,{children:`Plan`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`profile.read`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`GET /profile`})}),_jsx(_components.td,{children:`Public profile, username and plan`}),_jsx(_components.td,{children:`Free`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`services.read`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`GET /services`}),`, `,_jsx(_components.code,{children:`GET /services/{id}`})]}),_jsx(_components.td,{children:`Your default and single-use services`}),_jsx(_components.td,{children:`Free`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`services.write`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`POST /services`}),`, `,_jsx(_components.code,{children:`PATCH /services/{id}`}),`, `,_jsx(_components.code,{children:`DELETE /services/{id}`})]}),_jsx(_components.td,{children:`Create, edit and delete your services and single-use links`}),_jsx(_components.td,{children:`Free`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`availability.read`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`GET /availability`})}),_jsx(_components.td,{children:`Available time slots`}),_jsx(_components.td,{children:`Free`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`bookings.read`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`GET /bookings`}),`, `,_jsx(_components.code,{children:`GET /bookings/{id}`})]}),_jsx(_components.td,{children:`Existing bookings`}),_jsx(_components.td,{children:`Free`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`webhooks.read`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`GET /webhooks`}),`, `,_jsx(_components.code,{children:`GET /webhooks/{id}`})]}),_jsx(_components.td,{children:`The webhooks this credential set up`}),_jsx(_components.td,{children:`Pro`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`webhooks.write`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`POST /webhooks`}),`, `,_jsx(_components.code,{children:`PATCH /webhooks/{id}`}),`, `,_jsx(_components.code,{children:`DELETE /webhooks/{id}`})]}),_jsxs(_components.td,{children:[`Send your booking updates to a URL. Creating and editing also need `,_jsx(_components.code,{children:`bookings.read`})]}),_jsx(_components.td,{children:`Pro`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`plans`,children:`Plans`}),`\n`,_jsxs(_components.p,{children:[`What a credential can do depends on the plan of the Tikk account it belongs to, not on the developer who built the app. Reading and managing your data works on every plan. Pro is for automation: `,_jsx(_components.a,{href:`/api-reference/webhooks`,children:`webhooks`}),`.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Free scopes work on every plan.`}),`\n`,_jsxs(_components.li,{children:[`Pro scopes can be granted on any plan, but only work while the account is on Tikk Pro. Calls from a Free account return `,_jsx(_components.code,{children:`403`}),` with `,_jsx(_components.code,{children:`\"error\": \"plan_required\"`}),`. See `,_jsx(_components.a,{href:`/api-reference/errors#plan-required-403`,children:`Errors`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Nothing needs to be reconnected or reissued when the plan changes. After an upgrade the same credential works immediately. After a downgrade, Pro calls return `,_jsx(_components.code,{children:`plan_required`}),` again and webhooks pause.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`The API also follows the account’s plan limits: creating a service beyond the Free limit returns the same `,_jsx(_components.code,{children:`plan_required`}),` error, just like it would be refused in the app.`]}),`\n`,_jsxs(_components.p,{children:[`To adapt your UI up front, read `,_jsx(_components.code,{children:`plan`}),` from `,_jsx(_components.a,{href:`/api-reference/profile/get-profile`,children:_jsx(_components.code,{children:`GET /profile`})}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`api-keys`,children:`API keys`}),`\n`,_jsxs(_components.p,{children:[`When you create a key under `,_jsx(_components.strong,{children:`Settings → API Keys`}),`, you choose which scopes it carries. Pick at least one. A key can only call endpoints for the scopes you gave it. You can have up to 10 active keys.`]}),`\n`,_jsx(Heading,{level:`2`,id:`oauth-tokens`,children:`OAuth tokens`}),`\n`,_jsxs(_components.p,{children:[`When building a partner app, request only the scopes your integration actually needs. You choose your app’s scopes when you register it in the `,_jsx(_components.a,{href:`https://developer.tikk.chat`,children:`developer portal`}),`. Specify them in the `,_jsx(_components.code,{children:`scope`}),` query parameter on the authorization URL as a space-separated list:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`6`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://app.tikk.chat/oauth/authorize`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ?client_id=YOUR_CLIENT_ID`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \u0026redirect_uri=https://yourapp.com/callback`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \u0026response_type=code`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \u0026scope=profile.read bookings.read`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(_components.p,{children:`The user sees exactly which scopes your app is requesting on Tikk’s consent screen. The resulting access token only carries the scopes you requested, even if the user’s account has broader permissions.`}),`\n`,_jsx(Heading,{level:`2`,id:`missing-scope-response`,children:`Missing scope response`}),`\n`,_jsxs(_components.p,{children:[`If you call an endpoint without the required scope, the API responds with `,_jsx(_components.code,{children:`403 Forbidden`}),` and the following body:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Missing required scope.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"scopes\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"bookings.read\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`scopes`}),` lists the scope or scopes the endpoint needs. A credential that holds them but belongs to a Free account gets `,_jsx(_components.code,{children:`plan_required`}),` instead on Pro endpoints. Check the `,_jsx(_components.a,{href:`/api-reference/errors`,children:`Errors`}),` page for the full list of error codes and their meanings.`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Request the minimum scopes your integration needs. Fewer scopes means smaller\nimpact if a token leaks. An attacker with a `,_jsx(_components.code,{children:`profile.read`}),`-only token can’t\nreach bookings data or change your services.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"API scopes. Access permissions for each endpoint","sidebarTitle":"Scopes","description":"What each scope grants, how to request scopes for OAuth tokens and what the API returns when a required scope is missing.","href":"/api-reference/scopes"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Available scopes","slug":"available-scopes","depth":2,"children":[]},{"title":"Plans","slug":"plans","depth":2,"children":[]},{"title":"API keys","slug":"api-keys","depth":2,"children":[]},{"title":"OAuth tokens","slug":"oauth-tokens","depth":2,"children":[]},{"title":"Missing scope response","slug":"missing-scope-response","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"tikk","siteName":"Tikk","title":"API scopes. Access permissions for each endpoint - Tikk","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T13:53:07.773Z","originalFileLocation":"api-reference/scopes.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"What each scope grants, how to request scopes for OAuth tokens and what the API returns when a required scope is missing.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Tikk\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tikk/6kYDnd2notRapCRL/_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/tikk/6kYDnd2notRapCRL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tikk/6kYDnd2notRapCRL/_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/tikk/6kYDnd2notRapCRL/_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/tikk/6kYDnd2notRapCRL/_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/tikk/6kYDnd2notRapCRL/_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/tikk/6kYDnd2notRapCRL/_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/tikk/6kYDnd2notRapCRL/_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/tikk/6kYDnd2notRapCRL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API scopes. Access permissions for each endpoint - Tikk\">\u003cmeta data-mint-head property=\"og:description\" content=\"What each scope grants, how to request scopes for OAuth tokens and what the API returns when a required scope is missing.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Tikk\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tikk.chat/api-reference/scopes\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tikk.mintlify.site/_mintlify/api/og/v2?division=Overview\u0026amp;title=API+scopes.+Access+permissions+for+each+endpoint\u0026amp;description=What+each+scope+grants%2C+how+to+request+scopes+for+OAuth+tokens+and+what+the+API+returns+when+a+required+scope+is+missing.\u0026amp;theme=f5439b58138018aeb9a1e01e\u0026amp;signature=04d9769ebf3a7e498846f413649745e03ffdf0110213568ad66c85ef57e45285\">\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=\"API scopes. Access permissions for each endpoint - Tikk\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"What each scope grants, how to request scopes for OAuth tokens and what the API returns when a required scope is missing.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tikk.mintlify.site/_mintlify/api/og/v2?division=Overview\u0026amp;title=API+scopes.+Access+permissions+for+each+endpoint\u0026amp;description=What+each+scope+grants%2C+how+to+request+scopes+for+OAuth+tokens+and+what+the+API+returns+when+a+required+scope+is+missing.\u0026amp;theme=f5439b58138018aeb9a1e01e\u0026amp;signature=04d9769ebf3a7e498846f413649745e03ffdf0110213568ad66c85ef57e45285\">\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/tikk/6kYDnd2notRapCRL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Tikk\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#848484\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tikk.chat/api-reference/scopes\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/scopes.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tikk.chat/#organization\",\"name\":\"Tikk\",\"url\":\"https://docs.tikk.chat\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tikk/V1Cxv-mnTLJxEuos/images/logo.svg?fit=max\u0026auto=format\u0026n=V1Cxv-mnTLJxEuos\u0026q=85\u0026s=3c872a88f73e2a482351b0af4a8f9664\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tikk.chat#website\",\"name\":\"Tikk\",\"url\":\"https://docs.tikk.chat\",\"publisher\":{\"@id\":\"https://docs.tikk.chat/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tikk.chat/api-reference/scopes#webpage\",\"url\":\"https://docs.tikk.chat/api-reference/scopes\",\"name\":\"API scopes. Access permissions for each endpoint\",\"description\":\"What each scope grants, how to request scopes for OAuth tokens and what the API returns when a required scope is missing.\",\"dateModified\":\"2026-11-12T13:53:07.773Z\",\"isPartOf\":{\"@id\":\"https://docs.tikk.chat#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tikk.chat/api-reference/scopes#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tikk.chat/api-reference/scopes#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Overview\",\"item\":\"https://docs.tikk.chat/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API scopes. Access permissions for each endpoint\",\"item\":\"https://docs.tikk.chat/api-reference/scopes\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.tikk.chat/api-reference/scopes#article\",\"headline\":\"API scopes. Access permissions for each endpoint\",\"name\":\"API scopes. Access permissions for each endpoint\",\"description\":\"What each scope grants, how to request scopes for OAuth tokens and what the API returns when a required scope is missing.\",\"url\":\"https://docs.tikk.chat/api-reference/scopes\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tikk.chat/api-reference/scopes#webpage\"},\"dateModified\":\"2026-11-12T13:53:07.773Z\",\"publisher\":{\"@id\":\"https://docs.tikk.chat/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tikk.chat#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Tikk\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Tikk\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/scopes.md","siteName":"Tikk","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Tikk REST API. Profile, services, availability and bookings","sidebarTitle":"Overview","href":"/api-reference/introduction"},{"title":"API authentication. API keys and OAuth tokens","sidebarTitle":"Authentication","description":"Authenticate API requests with API keys or OAuth access tokens. Send credentials and handle common auth errors.","href":"/api-reference/authentication"},{"title":"API scopes. Access permissions for each endpoint","sidebarTitle":"Scopes","href":"/api-reference/scopes"},{"title":"API errors and HTTP status codes","sidebarTitle":"Errors","description":"Every HTTP error code, JSON response shape, rate limit header and guidance on handling each error.","href":"/api-reference/errors"}]},{"group":"Profile","icon":"user","pages":[{"title":"Get your profile","openapi":"api-reference/openapi.yaml GET /profile","href":"/api-reference/profile/get-profile"}]},{"group":"Services","icon":"layers","pages":[{"title":"List your services","openapi":"api-reference/openapi.yaml GET /services","href":"/api-reference/services/list-services"},{"title":"Get a service","openapi":"api-reference/openapi.yaml GET /services/{id}","href":"/api-reference/services/get-service"},{"title":"Create a service","openapi":"api-reference/openapi.yaml POST /services","href":"/api-reference/services/create-service"},{"title":"Edit a default service","openapi":"api-reference/openapi.yaml PATCH /services/{id}","href":"/api-reference/services/update-service"},{"title":"Delete a service","openapi":"api-reference/openapi.yaml DELETE /services/{id}","href":"/api-reference/services/delete-service"}]},{"group":"Availability","icon":"calendar","pages":[{"title":"List your free time slots","openapi":"api-reference/openapi.yaml GET /availability","href":"/api-reference/availability/list-availability"}]},{"group":"Bookings","icon":"list","pages":[{"title":"List your bookings","openapi":"api-reference/openapi.yaml GET /bookings","href":"/api-reference/bookings/list-bookings"},{"title":"Get a booking","openapi":"api-reference/openapi.yaml GET /bookings/{id}","href":"/api-reference/bookings/get-booking"}]},{"group":"Webhooks","icon":"webhook","pages":[{"title":"Webhooks. Booking updates pushed to your URL","sidebarTitle":"Webhooks","href":"/api-reference/webhooks"},{"title":"List your webhooks","openapi":"api-reference/openapi.yaml GET /webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Create a webhook","openapi":"api-reference/openapi.yaml POST /webhooks","href":"/api-reference/webhooks/create-webhook"},{"title":"Get a webhook","openapi":"api-reference/openapi.yaml GET /webhooks/{id}","href":"/api-reference/webhooks/get-webhook"},{"title":"Update a webhook","openapi":"api-reference/openapi.yaml PATCH /webhooks/{id}","href":"/api-reference/webhooks/update-webhook"},{"title":"Delete a webhook","openapi":"api-reference/openapi.yaml DELETE /webhooks/{id}","href":"/api-reference/webhooks/delete-webhook"}]}]}]},"basePath":"","title":"API scopes. Access permissions for each endpoint - Tikk","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":[],"chunks":[]}