Public API v1 is read-only at launch.Current operations:
GET /api/public/v1/customers (clients:read; clients.sensitive:read for date of birth and gender)
GET /api/public/v1/appointments (appointments:read)
Dashboard and session-authenticated /api/* routes are not part of the public contract.
Writes
Creating, updating or deleting records through the API is not available. Until this page changes, integrations should use the read-only endpoints and org webhooks.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cicini API","description":"Developer documentation for the Cicini Public API v1","colors":{"primary":"#193C32","light":"#2B5548","dark":"#C19A67"},"api":{"playground":{"display":"interactive"}},"navbar":{"links":[{"href":"https://cicini.com","label":"App"},{"href":"https://cicini.com/pricing","label":"Pricing"},{"href":"https://cicini.com/openapi.json","label":"OpenAPI"}]},"footer":{"socials":{"website":"https://cicini.com"}},"seo":{"metatags":{"og:site_name":"Cicini API Docs","canonical":"https://docs.cicini.com"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cicini","hasAudioNarration":false,"actualSubdomain":"cicini","customDomains":["docs.cicini.com"],"gitSource":{"type":"github","owner":"marloostudio","repo":"cicini","deployBranch":"main","contentDirectory":"developer-docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae84d0d3630049289fe2b4d","clientVersion":"0.0.4142","searchFilterCounts":[{"language":"default","tag":"Guides","count":12},{"language":"default","tag":"Get started","count":8},{"language":"default","tag":"Examples","count":2},{"language":"default","tag":"Core resources","count":2},{"language":"default","tag":"API Reference","count":2},{"language":"default","tag":"Appointments","count":1},{"language":"default","tag":"Customers","count":1}]},"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":[],"page":{"pagePath":"guides/write-surface","slug":"/guides/write-surface","pageMetadata":{"title":"Public API write surface","description":"What the Cicini Public API can and cannot do","href":"/guides/write-surface"},"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 the Cicini Public API can and cannot 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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Public API v1 is `,_jsx(_components.strong,{children:`read-only`}),` at launch.`]}),`\n`,_jsx(_components.p,{children:`Current operations:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`GET /api/public/v1/customers`}),` (`,_jsx(_components.code,{children:`clients:read`}),`; `,_jsx(_components.code,{children:`clients.sensitive:read`}),` for date of birth and gender)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`GET /api/public/v1/appointments`}),` (`,_jsx(_components.code,{children:`appointments:read`}),`)`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Dashboard and session-authenticated `,_jsx(_components.code,{children:`/api/*`}),` routes are not part of the public contract.`]}),`\n`,_jsx(Heading,{level:`2`,id:`writes`,children:`Writes`}),`\n`,_jsx(_components.p,{children:`Creating, updating or deleting records through the API is not available. Until this page changes, integrations should use the read-only endpoints and org webhooks.`})]})}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":"Public API write surface","description":"What the Cicini Public API can and cannot do","href":"/guides/write-surface"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Writes","slug":"writes","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"cicini","siteName":"Cicini API","title":"Public API write surface - Cicini API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-02T08:43:00.064Z","originalFileLocation":"guides/write-surface.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=\"What the Cicini Public API can and cannot do\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cicini API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cicini/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cicini/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cicini/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/cicini/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Public API write surface - Cicini API\">\u003cmeta data-mint-head property=\"og:description\" content=\"What the Cicini Public API can and cannot do\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cicini API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cicini.com/guides/write-surface\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cicini.mintlify.site/_mintlify/api/og/v2?division=Get+started\u0026amp;title=Public+API+write+surface\u0026amp;description=What+the+Cicini+Public+API+can+and+cannot+do\u0026amp;theme=9c253b9ba0823ddd4e9a44b3\u0026amp;signature=c6ce5cc31a7b8b25f9d38a7b10140d49d9f2d7418802138b83d045d37faad046\">\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=\"Public API write surface - Cicini API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"What the Cicini Public API can and cannot do\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cicini.mintlify.site/_mintlify/api/og/v2?division=Get+started\u0026amp;title=Public+API+write+surface\u0026amp;description=What+the+Cicini+Public+API+can+and+cannot+do\u0026amp;theme=9c253b9ba0823ddd4e9a44b3\u0026amp;signature=c6ce5cc31a7b8b25f9d38a7b10140d49d9f2d7418802138b83d045d37faad046\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/cicini/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cicini API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#193C32\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cicini.com/guides/write-surface\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/guides/write-surface.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cicini.com/#organization\",\"name\":\"Cicini API\",\"url\":\"https://docs.cicini.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cicini.com#website\",\"name\":\"Cicini API\",\"url\":\"https://docs.cicini.com\",\"publisher\":{\"@id\":\"https://docs.cicini.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cicini.com/guides/write-surface#webpage\",\"url\":\"https://docs.cicini.com/guides/write-surface\",\"name\":\"Public API write surface\",\"description\":\"What the Cicini Public API can and cannot do\",\"dateModified\":\"2026-11-02T08:43:00.064Z\",\"isPartOf\":{\"@id\":\"https://docs.cicini.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cicini.com/guides/write-surface#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cicini.com/guides/write-surface#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Get started\",\"item\":\"https://docs.cicini.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Public API write surface\",\"item\":\"https://docs.cicini.com/guides/write-surface\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.cicini.com/guides/write-surface#article\",\"headline\":\"Public API write surface\",\"name\":\"Public API write surface\",\"description\":\"What the Cicini Public API can and cannot do\",\"url\":\"https://docs.cicini.com/guides/write-surface\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cicini.com/guides/write-surface#webpage\"},\"dateModified\":\"2026-11-02T08:43:00.064Z\",\"publisher\":{\"@id\":\"https://docs.cicini.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cicini.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cicini API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Cicini API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/guides/write-surface.md","siteName":"Cicini API","nav":{"global":null,"tabs":[{"tab":"Guides","groups":[{"group":"Get started","pages":[{"title":"Overview","href":""},{"title":"Getting started","href":"/guides/getting-started"},{"title":"Authentication","href":"/guides/authentication"},{"title":"Pagination","href":"/guides/pagination"},{"title":"Errors","href":"/guides/errors"},{"title":"Rate limits","href":"/guides/rate-limits"},{"title":"Public vs internal","description":"What is safe for integrations vs Cicini-only APIs","href":"/guides/api-surface"},{"title":"Public API write surface","href":"/guides/write-surface"}]},{"group":"Core resources","pages":[{"title":"Customers","description":"List organization customers via Public API v1","href":"/resources/customers"},{"title":"Appointments","href":"/resources/appointments"}]},{"group":"Examples","pages":[{"title":"cURL cookbook","href":"/examples/curl"},{"title":"Node.js example","href":"/examples/node"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/customers/list-customers"}]}]},"basePath":"","title":"Public API write surface - Cicini API","buildId":"dpl_G2Qd45vZZ7MkBiGF9yYx8ZsbbKXX","deploymentId":"dpl_G2Qd45vZZ7MkBiGF9yYx8ZsbbKXX","dynamics":[],"chunks":[]}