Partner API only (/v4/partner/*): a Partner API key (format: mgp_) from the Partner portal. Its workspace tokens (mgw…) authenticate on the other Platform API endpoints like an API key, for one customer workspace.
{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}
{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}
{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}
{
"statusCode": 400,
"message": [
"limit must not be greater than 100"
],
"error": "BadRequestException"
}
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"meetergo","colors":{"primary":"#2563eb","light":"#3b82f6","dark":"#1d4ed8"},"logo":{"light":"https://mintcdn.com/meetergo/NDOgY9QfmSWwQYKs/logo/icon.svg?fit=max\u0026auto=format\u0026n=NDOgY9QfmSWwQYKs\u0026q=85\u0026s=61dca505b7df3e5fce73917f501b9216","dark":"https://mintcdn.com/meetergo/NDOgY9QfmSWwQYKs/logo/icon.svg?fit=max\u0026auto=format\u0026n=NDOgY9QfmSWwQYKs\u0026q=85\u0026s=61dca505b7df3e5fce73917f501b9216"},"favicon":"https://mintcdn.com/meetergo/NDOgY9QfmSWwQYKs/logo/icon.svg?fit=max\u0026auto=format\u0026n=NDOgY9QfmSWwQYKs\u0026q=85\u0026s=61dca505b7df3e5fce73917f501b9216","api":{"playground":{}},"navbar":{"links":[{"href":"https://my.meetergo.com","label":"Dashboard"}],"primary":{"type":"button","label":"Get Started","href":"https://my.meetergo.com/signup"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/meetergo","x":"https://twitter.com/meetergo"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"meetergo","hasAudioNarration":false,"actualSubdomain":"meetergo","customDomains":["developer.meetergo.com"],"gitSource":{"type":"github","owner":"dominikrapacki","repo":"meetergo-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a967f8249ac06b762a7f27a","collectionId":"d59d50b5-59a4-4a13-af3a-48909a0e2667","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a967f8249ac06b762a7f27a"},"entitlements":{},"buildId":"6aed839a1815a54e8ea5b29c","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"API Reference","count":338},{"language":"default","tag":"Developer Guide","count":40},{"language":"default","tag":"space","count":31},{"language":"default","tag":"Invoicing Documents","count":25},{"language":"default","tag":"CRM Deals","count":22},{"language":"default","tag":"Core Concepts","count":13},{"language":"default","tag":"Appointment V4","count":12},{"language":"default","tag":"Booking Link V4","count":12},{"language":"default","tag":"availability","count":11},{"language":"default","tag":"CRM Attachments","count":11}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":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":"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":[],"page":{"pagePath":"api-reference/partner-api/create-a-customer-workspace","slug":"/api-reference/partner-api/create-a-customer-workspace","pageMetadata":{"title":"Create a customer workspace","description":"Creates a managed customer company, invites its admin, and optionally starts it from an industry template (`templateKey`). Idempotent per `requestId`.","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/partner/customers","href":"/api-reference/partner-api/create-a-customer-workspace","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Creates a managed customer company, invites its admin, and optionally starts it from an industry template (\", _jsx(_components.code, {\n children: \"templateKey\"\n }), \"). Idempotent per \", _jsx(_components.code, {\n children: \"requestId\"\n }), \".\"]\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":"Create a customer workspace","description":"Creates a managed customer company, invites its admin, and optionally starts it from an industry template (`templateKey`). Idempotent per `requestId`.","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/partner/customers","href":"/api-reference/partner-api/create-a-customer-workspace","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Creates a managed customer company, invites its admin, and optionally starts it from an industry template (`templateKey`). Idempotent per `requestId`.","operationId":"createCustomer","parameters":[],"requestBody":"1a6367cb-0f2c-474a-a876-55a71a6aef16","responses":{"201":"ffcf1968-e7cb-46f4-8486-e3cc006945da","400":"9893e30d-9099-49dc-b2b6-8ec0ce8c8fe0","401":"337bcf4a-74d4-48e7-a703-2b4dc5d7e080","403":"704447b8-5213-4f2d-a8d8-a3cb5ee13d92","429":"33b1f722-ec57-49c4-9d1b-510ae65269e5"},"security":["e67d5453-25c6-45a6-9079-e9181856a7f8"],"summary":"Create a customer workspace","tags":["Partner API"],"method":"post","type":"path","servers":["eaaa1556-90a7-4132-ba89-356339ee40c9"],"path":"/v4/partner/customers","baseUrlOptions":["https://api.meetergo.com"],"title":"Create a customer workspace","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$","isRequired":true,"uniqueKey":"requestId","typeLabel":"string\u003cuuid>"},"companyName":{"type":"string","minLength":1,"maxLength":100,"isRequired":true,"uniqueKey":"companyName","typeLabel":"string"},"adminFirstName":{"type":"string","minLength":1,"maxLength":100,"isRequired":true,"uniqueKey":"adminFirstName","typeLabel":"string"},"adminLastName":{"type":"string","minLength":1,"maxLength":100,"isRequired":true,"uniqueKey":"adminLastName","typeLabel":"string"},"adminEmail":{"type":"string","maxLength":100,"format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","isRequired":true,"uniqueKey":"adminEmail","typeLabel":"string\u003cemail>"},"language":{"type":"string","minLength":2,"maxLength":10,"isRequired":true,"uniqueKey":"language","typeLabel":"string"},"timezone":{"type":"string","minLength":1,"maxLength":100,"isRequired":true,"uniqueKey":"timezone","typeLabel":"string"},"billingResponsibility":{"type":"string","enum":["partner","customer"],"isRequired":true,"uniqueKey":"billingResponsibility","typeLabel":"enum\u003cstring>"},"communicationOwner":{"type":"string","enum":["partner","meetergo"],"isRequired":true,"uniqueKey":"communicationOwner","typeLabel":"enum\u003cstring>"},"contactConsentConfirmed":{"type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"contactConsentConfirmed","typeLabel":"enum\u003cboolean>"},"suiteTier":{"type":"string","enum":["light","suite","premium"],"uniqueKey":"suiteTier","typeLabel":"enum\u003cstring>"},"extraEmails":{"maxItems":100,"type":"array","items":{"type":"string","maxLength":100,"format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","uniqueKey":"extraEmails.items.[INDEX]","typeLabel":"string\u003cemail>"},"uniqueKey":"extraEmails","typeLabel":"string\u003cemail>[]"},"partnerRetailPricePerSeatEur":{"type":"string","pattern":"^(?:0|[1-9]\\d{0,5})(?:\\.\\d{1,2})?$","uniqueKey":"partnerRetailPricePerSeatEur","typeLabel":"string"},"templateKey":{"type":"string","enum":["beauty","craftsmen","insurance","consulting"],"uniqueKey":"templateKey","typeLabel":"enum\u003cstring>"}},"required":["requestId","companyName","adminFirstName","adminLastName","adminEmail","language","timezone","billingResponsibility","communicationOwner","contactConsentConfirmed"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"requestId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","companyName":"\u003cstring>","adminFirstName":"\u003cstring>","adminLastName":"\u003cstring>","adminEmail":"jsmith@example.com","language":"\u003cstring>","timezone":"\u003cstring>","contactConsentConfirmed":true,"extraEmails":["jsmith@example.com"],"partnerRetailPricePerSeatEur":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ffcf1968-e7cb-46f4-8486-e3cc006945da":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$","isRequired":true,"uniqueKey":"customer.id","typeLabel":"string\u003cuuid>"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$","isRequired":true,"uniqueKey":"customer.companyId","typeLabel":"string\u003cuuid>"},"companyName":{"type":"string","isRequired":true,"uniqueKey":"customer.companyName","typeLabel":"string"},"admin":{"type":"object","properties":{"firstName":{"type":"string","isRequired":true,"uniqueKey":"customer.admin.firstName","typeLabel":"string"},"lastName":{"type":"string","isRequired":true,"uniqueKey":"customer.admin.lastName","typeLabel":"string"},"email":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"customer.admin.email.oneOf.0","typeLabel":"string"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"customer.admin.email.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"customer.admin.email.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"customer.admin.email","typeLabel":"string | enum\u003cstring> | null"},"status":{"type":"string","enum":["pending","active"],"isRequired":true,"uniqueKey":"customer.admin.status","typeLabel":"enum\u003cstring>"}},"required":["firstName","lastName","email","status"],"additionalProperties":false,"isRequired":true,"uniqueKey":"customer.admin","typeLabel":"object"},"tier":{"type":"string","enum":["basic","essentials","growth","teams","light","suite","premium","enterprise"],"isRequired":true,"uniqueKey":"customer.tier","typeLabel":"enum\u003cstring>"},"billingResponsibility":{"type":"string","enum":["partner","customer"],"isRequired":true,"uniqueKey":"customer.billingResponsibility","typeLabel":"enum\u003cstring>"},"partnerRetailPricePerSeatEur":{"oneOf":[{"type":"string","pattern":"^(?:0|[1-9]\\d{0,5})(?:\\.\\d{1,2})?$","isRequired":true,"uniqueKey":"customer.partnerRetailPricePerSeatEur.oneOf.0","typeLabel":"string"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"customer.partnerRetailPricePerSeatEur.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"customer.partnerRetailPricePerSeatEur.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"customer.partnerRetailPricePerSeatEur","typeLabel":"string | enum\u003cstring> | null"},"communicationOwner":{"type":"string","enum":["partner","meetergo"],"isRequired":true,"uniqueKey":"customer.communicationOwner","typeLabel":"enum\u003cstring>"},"licensedSeats":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"customer.licensedSeats","typeLabel":"integer"},"partnerBillableSeats":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"customer.partnerBillableSeats","typeLabel":"integer"},"estimatedMonthlyNetCents":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"customer.estimatedMonthlyNetCents","typeLabel":"integer"},"activePartnerAccess":{"type":"boolean","isRequired":true,"uniqueKey":"customer.activePartnerAccess","typeLabel":"boolean"},"isPartnerDemo":{"type":"boolean","isRequired":true,"uniqueKey":"customer.isPartnerDemo","typeLabel":"boolean"},"createdAt":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"customer.createdAt","typeLabel":"string\u003cdate-time>"},"bookingPageUrl":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"customer.bookingPageUrl.oneOf.0","typeLabel":"string"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"customer.bookingPageUrl.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"customer.bookingPageUrl.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"customer.bookingPageUrl","typeLabel":"string | enum\u003cstring> | null"}},"required":["id","companyId","companyName","admin","tier","billingResponsibility","partnerRetailPricePerSeatEur","communicationOwner","licensedSeats","partnerBillableSeats","estimatedMonthlyNetCents","activePartnerAccess","isPartnerDemo","createdAt","bookingPageUrl"],"additionalProperties":false,"isRequired":true,"uniqueKey":"customer","typeLabel":"object"},"template":{"oneOf":[{"type":"object","required":["key","version","meetingTypes"],"properties":{"key":{"type":"string","enum":["beauty","craftsmen","insurance","consulting"],"isRequired":true,"uniqueKey":"template.oneOf.0.key","typeLabel":"enum\u003cstring>"},"version":{"type":"integer","exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0,"isRequired":true,"uniqueKey":"template.oneOf.0.version","typeLabel":"integer"},"meetingTypes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$","isRequired":true,"uniqueKey":"template.oneOf.0.meetingTypes.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"template.oneOf.0.meetingTypes.items.[INDEX].name","typeLabel":"string"},"slug":{"type":"string","isRequired":true,"uniqueKey":"template.oneOf.0.meetingTypes.items.[INDEX].slug","typeLabel":"string"}},"required":["id","name","slug"],"additionalProperties":false,"uniqueKey":"template.oneOf.0.meetingTypes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"template.oneOf.0.meetingTypes","typeLabel":"object[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"template.oneOf.0","typeLabel":"object"},{"type":"string","enum":[null],"isRequired":true,"uniqueKey":"template.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","enum":[null],"isRequired":true,"uniqueKey":"template.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"template","typeLabel":"object | enum\u003cstring> | null"},"setupStatus":{"type":"string","enum":["ready","attention_required"],"isRequired":true,"uniqueKey":"setupStatus","typeLabel":"enum\u003cstring>"},"setupAttention":{"type":"array","items":{"type":"string","enum":["customer_billing_setup_failed","booking_page_setup_failed","template_setup_failed"],"uniqueKey":"setupAttention.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"setupAttention","typeLabel":"enum\u003cstring>[]"},"adminInviteDelivery":{"type":"string","enum":["sent","failed"],"isRequired":true,"uniqueKey":"adminInviteDelivery","typeLabel":"enum\u003cstring>"},"additionalInvites":{"type":"object","properties":{"processedEmails":{"type":"array","items":{"type":"string","uniqueKey":"additionalInvites.processedEmails.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"additionalInvites.processedEmails","typeLabel":"string[]"},"unprocessedEmails":{"type":"array","items":{"type":"string","uniqueKey":"additionalInvites.unprocessedEmails.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"additionalInvites.unprocessedEmails","typeLabel":"string[]"},"deliveryFailedEmails":{"type":"array","items":{"type":"string","uniqueKey":"additionalInvites.deliveryFailedEmails.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"additionalInvites.deliveryFailedEmails","typeLabel":"string[]"}},"required":["processedEmails","unprocessedEmails","deliveryFailedEmails"],"additionalProperties":false,"isRequired":true,"uniqueKey":"additionalInvites","typeLabel":"object"}},"required":["customer","template","setupStatus","setupAttention","adminInviteDelivery","additionalInvites"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"customer":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","companyId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","companyName":"\u003cstring>","admin":{"firstName":"\u003cstring>","lastName":"\u003cstring>","email":"\u003cstring>","status":"pending"},"tier":"basic","billingResponsibility":"partner","partnerRetailPricePerSeatEur":"\u003cstring>","communicationOwner":"partner","licensedSeats":4503599627370495,"partnerBillableSeats":4503599627370495,"estimatedMonthlyNetCents":4503599627370495,"activePartnerAccess":true,"isPartnerDemo":true,"createdAt":"2023-11-07T05:31:56Z","bookingPageUrl":"\u003cstring>"},"template":{"key":"beauty","version":4503599627370495,"meetingTypes":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","slug":"\u003cstring>"}]},"setupStatus":"ready","setupAttention":["customer_billing_setup_failed"],"adminInviteDelivery":"sent","additionalInvites":{"processedEmails":["\u003cstring>"],"unprocessedEmails":["\u003cstring>"],"deliveryFailedEmails":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"9893e30d-9099-49dc-b2b6-8ec0ce8c8fe0":{"description":"The request did not validate. `message` lists the constraints that failed.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","message"],"properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"oneOf":[{"type":"string","description":"A sentence, or the list of field constraints that failed. Validation errors name the offending property.","example":["limit must not be greater than 100"],"isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"A sentence, or the list of field constraints that failed. Validation errors name the offending property.","example":["limit must not be greater than 100"],"isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"error":{"type":"string","example":"BadRequestException","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"message":["limit must not be greater than 100"],"error":"BadRequestException"}}},"exampleType":"generated"}},"exampleType":"generated"},"337bcf4a-74d4-48e7-a703-2b4dc5d7e080":{"description":"Missing, malformed, or expired credentials.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","message"],"properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"oneOf":[{"type":"string","description":"A sentence, or the list of field constraints that failed. Validation errors name the offending property.","example":["limit must not be greater than 100"],"isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"A sentence, or the list of field constraints that failed. Validation errors name the offending property.","example":["limit must not be greater than 100"],"isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"error":{"type":"string","example":"BadRequestException","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"message":["limit must not be greater than 100"],"error":"BadRequestException"}}},"exampleType":"generated"}},"exampleType":"generated"},"704447b8-5213-4f2d-a8d8-a3cb5ee13d92":{"description":"Authenticated, but not allowed: the plan does not include this feature, or the token is scoped away from it.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","message"],"properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"oneOf":[{"type":"string","description":"A sentence, or the list of field constraints that failed. Validation errors name the offending property.","example":["limit must not be greater than 100"],"isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"A sentence, or the list of field constraints that failed. Validation errors name the offending property.","example":["limit must not be greater than 100"],"isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"error":{"type":"string","example":"BadRequestException","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"message":["limit must not be greater than 100"],"error":"BadRequestException"}}},"exampleType":"generated"}},"exampleType":"generated"},"33b1f722-ec57-49c4-9d1b-510ae65269e5":{"description":"Rate limited. Back off and retry.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","message"],"properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"oneOf":[{"type":"string","description":"A sentence, or the list of field constraints that failed. Validation errors name the offending property.","example":["limit must not be greater than 100"],"isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"A sentence, or the list of field constraints that failed. Validation errors name the offending property.","example":["limit must not be greater than 100"],"isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"error":{"type":"string","example":"BadRequestException","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"message":["limit must not be greater than 100"],"error":"BadRequestException"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"e67d5453-25c6-45a6-9079-e9181856a7f8":{"PartnerApiKey":{"scheme":"bearer","bearerFormat":"Partner API key","type":"http","description":"Partner API only (/v4/partner/*): a Partner API key (format: mgp_\u003cid>_\u003csecret>) from the Partner portal. Its workspace tokens (mgw_…) authenticate on the other Platform API endpoints like an API key, for one customer workspace.","scopes":[],"schemeName":"PartnerApiKey"}}},"servers":{"eaaa1556-90a7-4132-ba89-356339ee40c9":{"url":"https://api.meetergo.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"Partner API key","type":"http","description":"Partner API only (/v4/partner/*): a Partner API key (format: mgp_\u003cid>_\u003csecret>) from the Partner portal. Its workspace tokens (mgw_…) authenticate on the other Platform API endpoints like an API key, for one customer workspace.","scopes":[],"schemeName":"PartnerApiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Partner API only (/v4/partner/*): a Partner API key (format: mgp_\u003cid>_\u003csecret>) from the Partner portal. Its workspace tokens (mgw_…) authenticate on the other Platform API endpoints like an API key, for one customer workspace.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"PartnerApiKey","name":"Authorization"}],"title":"PartnerApiKey"}]},"originalFileLocation":"openapi.json"},"subdomain":"meetergo","siteName":"meetergo","title":"Create a customer workspace - meetergo","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T07:37:11.113Z","originalFileLocation":"api-reference/partner-api/create-a-customer-workspace.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=\"Creates a managed customer company, invites its admin, and optionally starts it from an industry template (templateKey). Idempotent per requestId.\">\u003cmeta data-mint-head name=\"application-name\" content=\"meetergo\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/meetergo/P2nshTH0TYuw-Wj1/_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/meetergo/P2nshTH0TYuw-Wj1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/meetergo/P2nshTH0TYuw-Wj1/_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/meetergo/P2nshTH0TYuw-Wj1/_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/meetergo/P2nshTH0TYuw-Wj1/_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/meetergo/P2nshTH0TYuw-Wj1/_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/meetergo/P2nshTH0TYuw-Wj1/_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/meetergo/P2nshTH0TYuw-Wj1/_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/meetergo/P2nshTH0TYuw-Wj1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a customer workspace - meetergo\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a managed customer company, invites its admin, and optionally starts it from an industry template (templateKey). Idempotent per requestId.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"meetergo\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.meetergo.com/api-reference/partner-api/create-a-customer-workspace\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://meetergo.mintlify.site/_mintlify/api/og/v2?division=Partner+API\u0026amp;title=Create+a+customer+workspace\u0026amp;description=Creates+a+managed+customer+company%2C+invites+its+admin%2C+and+optionally+starts+it+from+an+industry+template+%28%60templateKey%60%29.+Idempotent+per+%60requestId%60.\u0026amp;theme=099878a5f0917707877c2845\u0026amp;signature=4a3b8db541af4d71ee77ad574e3fea7a21b0f0e7a0d4d4b3746ed203665e3c95\">\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=\"Create a customer workspace - meetergo\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a managed customer company, invites its admin, and optionally starts it from an industry template (templateKey). Idempotent per requestId.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://meetergo.mintlify.site/_mintlify/api/og/v2?division=Partner+API\u0026amp;title=Create+a+customer+workspace\u0026amp;description=Creates+a+managed+customer+company%2C+invites+its+admin%2C+and+optionally+starts+it+from+an+industry+template+%28%60templateKey%60%29.+Idempotent+per+%60requestId%60.\u0026amp;theme=099878a5f0917707877c2845\u0026amp;signature=4a3b8db541af4d71ee77ad574e3fea7a21b0f0e7a0d4d4b3746ed203665e3c95\">\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/meetergo/P2nshTH0TYuw-Wj1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"meetergo\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563eb\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.meetergo.com/api-reference/partner-api/create-a-customer-workspace\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/partner-api/create-a-customer-workspace.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.meetergo.com/#organization\",\"name\":\"meetergo\",\"url\":\"https://developer.meetergo.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/meetergo/NDOgY9QfmSWwQYKs/logo/icon.svg?fit=max\u0026auto=format\u0026n=NDOgY9QfmSWwQYKs\u0026q=85\u0026s=61dca505b7df3e5fce73917f501b9216\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.meetergo.com#website\",\"name\":\"meetergo\",\"url\":\"https://developer.meetergo.com\",\"publisher\":{\"@id\":\"https://developer.meetergo.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.meetergo.com/api-reference/partner-api/create-a-customer-workspace#webpage\",\"url\":\"https://developer.meetergo.com/api-reference/partner-api/create-a-customer-workspace\",\"name\":\"Create a customer workspace\",\"description\":\"Creates a managed customer company, invites its admin, and optionally starts it from an industry template (templateKey). Idempotent per requestId.\",\"dateModified\":\"2026-11-06T07:37:11.113Z\",\"isPartOf\":{\"@id\":\"https://developer.meetergo.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.meetergo.com/api-reference/partner-api/create-a-customer-workspace#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.meetergo.com/api-reference/partner-api/create-a-customer-workspace#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Partner API\",\"item\":\"https://developer.meetergo.com/api-reference/partner-api/list-your-customer-workspaces\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a customer workspace\",\"item\":\"https://developer.meetergo.com/api-reference/partner-api/create-a-customer-workspace\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.meetergo.com/api-reference/partner-api/create-a-customer-workspace#apireference\",\"headline\":\"Create a customer workspace\",\"name\":\"Create a customer workspace\",\"description\":\"Creates a managed customer company, invites its admin, and optionally starts it from an industry template (templateKey). Idempotent per requestId.\",\"url\":\"https://developer.meetergo.com/api-reference/partner-api/create-a-customer-workspace\",\"mainEntityOfPage\":{\"@id\":\"https://developer.meetergo.com/api-reference/partner-api/create-a-customer-workspace#webpage\"},\"dateModified\":\"2026-11-06T07:37:11.113Z\",\"publisher\":{\"@id\":\"https://developer.meetergo.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.meetergo.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"meetergo\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"meetergo","nav":{"global":null,"tabs":[{"tab":"Developer Guide","pages":[{"title":"Developer Guide","href":"/developer-docs/introduction"}]},{"tab":"API Reference","groups":[{"group":"CRM Contacts","pages":[{"title":"Get crm","deprecated":null,"version":null,"openapi":"/openapi.json get /crm","href":"/api-reference/crm-contacts/get-crm"},{"title":"Create a new contact","deprecated":null,"version":null,"openapi":"/openapi.json post /crm","href":"/api-reference/crm-contacts/create-a-new-contact"},{"title":"Delete crm","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/{id}","href":"/api-reference/crm-contacts/delete-crm"},{"title":"Patch crm","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/{id}","href":"/api-reference/crm-contacts/patch-crm"},{"title":"Get a contact by ID or attendee ID with all its data including form submissions","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/details","href":"/api-reference/crm-contacts/get-a-contact-by-id-or-attendee-id-with-all-its-data-including-form-submissions"},{"title":"Bulk create contacts from CSV import\nThrottled to prevent abuse - max 3 requests per minute per user","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/bulk","href":"/api-reference/crm-contacts/bulk-create-contacts-from-csv-importthrottled-to-prevent-abuse--max-3-requests-per-minute-per-user"},{"title":"Bulk delete contacts. Only contacts belonging to the requesting user's\ncompany are removed; the result reports how many were deleted vs\nskipped so the UI can surface partial failures.\nThrottled tightly — destructive action, max 3 requests per minute.","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/bulk-delete","href":"/api-reference/crm-contacts/bulk-delete-contacts-only-contacts-belonging-to-the-requesting-userscompany-are-removed;-the-result-reports-how-many-were-deleted-vsskipped-so-the-ui-can-surface-partial-failuresthrottled-tightly-—-destructive-action-max-3-requests-per-minute"},{"title":"Get crmcontacts activity","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/contacts/{contactId}/activity","href":"/api-reference/crm-contacts/get-crmcontacts-activity"}]},{"group":"CRM Pipelines","pages":[{"title":"Get crmpipelines","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/pipelines","href":"/api-reference/crm-pipelines/get-crmpipelines"},{"title":"Post crmpipelines","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/pipelines","href":"/api-reference/crm-pipelines/post-crmpipelines"},{"title":"Get crmpipelinesdefault","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/pipelines/default","href":"/api-reference/crm-pipelines/get-crmpipelinesdefault"},{"title":"Get crmpipelines 1","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/pipelines/{id}","href":"/api-reference/crm-pipelines/get-crmpipelines-1"},{"title":"Delete crmpipelines","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/pipelines/{id}","href":"/api-reference/crm-pipelines/delete-crmpipelines"},{"title":"Patch crmpipelines","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/pipelines/{id}","href":"/api-reference/crm-pipelines/patch-crmpipelines"},{"title":"Post crmpipelines stages","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/pipelines/{pipelineId}/stages","href":"/api-reference/crm-pipelines/post-crmpipelines-stages"},{"title":"Patch crmpipelines stagesreorder","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/pipelines/{pipelineId}/stages/reorder","href":"/api-reference/crm-pipelines/patch-crmpipelines-stagesreorder"},{"title":"Delete crmpipelines stages","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/pipelines/{pipelineId}/stages/{stageId}","href":"/api-reference/crm-pipelines/delete-crmpipelines-stages"},{"title":"Patch crmpipelines stages","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/pipelines/{pipelineId}/stages/{stageId}","href":"/api-reference/crm-pipelines/patch-crmpipelines-stages"}]},{"group":"CRM Settings","pages":[{"title":"The custom field definitions for one CRM record type.\n\n`recordType` defaults to `deal` so callers written before companies had\nfields — including a web bundle a browser is still holding — keep getting\nthe list they asked for.","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/settings/custom-fields","href":"/api-reference/crm-settings/the-custom-field-definitions-for-one-crm-record-type`recordtype`-defaults-to-`deal`-so-callers-written-before-companies-hadfields-—-including-a-web-bundle-a-browser-is-still-holding-—-keep-gettingthe-list-they-asked-for"},{"title":"Replace the custom field definitions for one CRM record type.","deprecated":null,"version":null,"openapi":"/openapi.json put /crm/settings/custom-fields","href":"/api-reference/crm-settings/replace-the-custom-field-definitions-for-one-crm-record-type"},{"title":"Get crmsettingslost reasons","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/settings/lost-reasons","href":"/api-reference/crm-settings/get-crmsettingslost-reasons"},{"title":"Put crmsettingslost reasons","deprecated":null,"version":null,"openapi":"/openapi.json put /crm/settings/lost-reasons","href":"/api-reference/crm-settings/put-crmsettingslost-reasons"}]},{"group":"CRM Tasks","pages":[{"title":"Get crmtasks","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/tasks","href":"/api-reference/crm-tasks/get-crmtasks"},{"title":"Post crmtasks","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/tasks","href":"/api-reference/crm-tasks/post-crmtasks"},{"title":"Get crmtaskssummary","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/tasks/summary","href":"/api-reference/crm-tasks/get-crmtaskssummary"},{"title":"Get crmtasksoverdue","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/tasks/overdue","href":"/api-reference/crm-tasks/get-crmtasksoverdue"},{"title":"Get crmtasksupcoming","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/tasks/upcoming","href":"/api-reference/crm-tasks/get-crmtasksupcoming"},{"title":"Get crmtasksby company","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/tasks/by-company/{crmCompanyId}","href":"/api-reference/crm-tasks/get-crmtasksby-company"},{"title":"Get crmtasks 1","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/tasks/{id}","href":"/api-reference/crm-tasks/get-crmtasks-1"},{"title":"Delete crmtasks","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/tasks/{id}","href":"/api-reference/crm-tasks/delete-crmtasks"},{"title":"Patch crmtasks","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/tasks/{id}","href":"/api-reference/crm-tasks/patch-crmtasks"},{"title":"Patch crmtasks complete","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/tasks/{id}/complete","href":"/api-reference/crm-tasks/patch-crmtasks-complete"},{"title":"Patch crmtasks uncomplete","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/tasks/{id}/uncomplete","href":"/api-reference/crm-tasks/patch-crmtasks-uncomplete"}]},{"group":"CRM Deals","pages":[{"title":"Post crmdeals merge","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/deals/{id}/merge","href":"/api-reference/crm-deals/post-crmdeals-merge"},{"title":"The deals that look like duplicates of this one.\n\nRead-only and merges nothing: the operator still picks. Offering the\ncandidates is the whole difference between a merge you use and a merge you\nhave to already know you need.","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{id}/duplicate-candidates","href":"/api-reference/crm-deals/the-deals-that-look-like-duplicates-of-this-oneread-only-and-merges-nothing:-the-operator-still-picks-offering-thecandidates-is-the-whole-difference-between-a-merge-you-use-and-a-merge-youhave-to-already-know-you-need"},{"title":"Contacts this deal is probably about, when none is linked yet.\n\nRead-only and links nothing — the operator confirms, because a wrong link\nmoves a stranger's email and meetings onto the deal.","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{id}/contact-suggestions","href":"/api-reference/crm-deals/contacts-this-deal-is-probably-about-when-none-is-linked-yetread-only-and-links-nothing-—-the-operator-confirms-because-a-wrong-linkmoves-a-strangers-email-and-meetings-onto-the-deal"},{"title":"Get crmdeals","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals","href":"/api-reference/crm-deals/get-crmdeals"},{"title":"Post crmdeals","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/deals","href":"/api-reference/crm-deals/post-crmdeals"},{"title":"Bulk \"import into pipeline\": upsert contacts and create one deal per row.\nThrottled generously so a chunked multi-batch import can complete.","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/deals/bulk-import","href":"/api-reference/crm-deals/bulk-\"import-into-pipeline\":-upsert-contacts-and-create-one-deal-per-rowthrottled-generously-so-a-chunked-multi-batch-import-can-complete"},{"title":"Get crmdealssummary","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/summary","href":"/api-reference/crm-deals/get-crmdealssummary"},{"title":"Get crmdealslimits","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/limits","href":"/api-reference/crm-deals/get-crmdealslimits"},{"title":"Get crmdealspipeline","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/pipeline/{pipelineId}","href":"/api-reference/crm-deals/get-crmdealspipeline"},{"title":"Optimized endpoint for kanban view - returns deals grouped by stage in a single request.\nThis eliminates the need for multiple paginated calls when loading the kanban board.","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/pipeline/{pipelineId}/grouped","href":"/api-reference/crm-deals/optimized-endpoint-for-kanban-view--returns-deals-grouped-by-stage-in-a-single-requestthis-eliminates-the-need-for-multiple-paginated-calls-when-loading-the-kanban-board"},{"title":"Get crmdeals 1","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{id}","href":"/api-reference/crm-deals/get-crmdeals-1"},{"title":"Delete crmdeals","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/deals/{id}","href":"/api-reference/crm-deals/delete-crmdeals"},{"title":"Patch crmdeals","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/deals/{id}","href":"/api-reference/crm-deals/patch-crmdeals"},{"title":"Patch crmdeals won","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/deals/{id}/won","href":"/api-reference/crm-deals/patch-crmdeals-won"},{"title":"Patch crmdeals lost","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/deals/{id}/lost","href":"/api-reference/crm-deals/patch-crmdeals-lost"},{"title":"Patch crmdeals reopen","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/deals/{id}/reopen","href":"/api-reference/crm-deals/patch-crmdeals-reopen"},{"title":"Get crmdeals contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{id}/contacts","href":"/api-reference/crm-deals/get-crmdeals-contacts"},{"title":"Post crmdeals contacts","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/deals/{id}/contacts","href":"/api-reference/crm-deals/post-crmdeals-contacts"},{"title":"Delete crmdeals contacts","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/deals/{id}/contacts/{dealContactId}","href":"/api-reference/crm-deals/delete-crmdeals-contacts"},{"title":"Patch crmdeals contacts","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/deals/{id}/contacts/{dealContactId}","href":"/api-reference/crm-deals/patch-crmdeals-contacts"},{"title":"Get crmdeals activity","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{id}/activity","href":"/api-reference/crm-deals/get-crmdeals-activity"},{"title":"Get crmdeals appointments","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{id}/appointments","href":"/api-reference/crm-deals/get-crmdeals-appointments"}]},{"group":"CRM Companies","pages":[{"title":"Get crmcompanies","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies","href":"/api-reference/crm-companies/get-crmcompanies"},{"title":"Post crmcompanies","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/companies","href":"/api-reference/crm-companies/post-crmcompanies"},{"title":"Get crmcompaniessummary","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies/summary","href":"/api-reference/crm-companies/get-crmcompaniessummary"},{"title":"Get crmcompaniesby domain","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies/by-domain/{domain}","href":"/api-reference/crm-companies/get-crmcompaniesby-domain"},{"title":"Get crmcompanies meeting history","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies/{id}/meeting-history","href":"/api-reference/crm-companies/get-crmcompanies-meeting-history"},{"title":"Get crmcompanies 1","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies/{id}","href":"/api-reference/crm-companies/get-crmcompanies-1"},{"title":"Delete crmcompanies","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/companies/{id}","href":"/api-reference/crm-companies/delete-crmcompanies"},{"title":"Patch crmcompanies","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/companies/{id}","href":"/api-reference/crm-companies/patch-crmcompanies"},{"title":"Get crmcompanies contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies/{id}/contacts","href":"/api-reference/crm-companies/get-crmcompanies-contacts"},{"title":"Get crmcompanies deals","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies/{id}/deals","href":"/api-reference/crm-companies/get-crmcompanies-deals"}]},{"group":"CRM Notes","pages":[{"title":"List notes for a deal, contact, or company","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/notes","href":"/api-reference/crm-notes/list-notes-for-a-deal-contact-or-company"},{"title":"Create a note on a deal, contact, or company","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/notes","href":"/api-reference/crm-notes/create-a-note-on-a-deal-contact-or-company"},{"title":"Delete a note","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/notes/{id}","href":"/api-reference/crm-notes/delete-a-note"},{"title":"Update a note","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/notes/{id}","href":"/api-reference/crm-notes/update-a-note"},{"title":"Get notes for a deal","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{dealId}/notes","href":"/api-reference/crm-notes/get-notes-for-a-deal"},{"title":"Create a note on a deal","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/deals/{dealId}/notes","href":"/api-reference/crm-notes/create-a-note-on-a-deal"},{"title":"Get notes for a contact","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/contacts/{contactId}/notes","href":"/api-reference/crm-notes/get-notes-for-a-contact"},{"title":"Create a note on a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/contacts/{contactId}/notes","href":"/api-reference/crm-notes/create-a-note-on-a-contact"},{"title":"Get notes for a CRM company","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies/{crmCompanyId}/notes","href":"/api-reference/crm-notes/get-notes-for-a-crm-company"},{"title":"Create a note on a CRM company","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/companies/{crmCompanyId}/notes","href":"/api-reference/crm-notes/create-a-note-on-a-crm-company"}]},{"group":"CRM Attachments","pages":[{"title":"List attachments for a deal, contact, or company","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/attachments","href":"/api-reference/crm-attachments/list-attachments-for-a-deal-contact-or-company"},{"title":"Attach a file to a deal, contact, or company","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/attachments","href":"/api-reference/crm-attachments/attach-a-file-to-a-deal-contact-or-company"},{"title":"Get download URL for an attachment","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/attachments/{id}/download","href":"/api-reference/crm-attachments/get-download-url-for-an-attachment"},{"title":"Delete an attachment","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/attachments/{id}","href":"/api-reference/crm-attachments/delete-an-attachment"},{"title":"Update an attachment","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/attachments/{id}","href":"/api-reference/crm-attachments/update-an-attachment"},{"title":"Get attachments for a deal","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{dealId}/attachments","href":"/api-reference/crm-attachments/get-attachments-for-a-deal"},{"title":"Attach a file to a deal","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/deals/{dealId}/attachments","href":"/api-reference/crm-attachments/attach-a-file-to-a-deal"},{"title":"Get attachments for a contact","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/contacts/{contactId}/attachments","href":"/api-reference/crm-attachments/get-attachments-for-a-contact"},{"title":"Attach a file to a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/contacts/{contactId}/attachments","href":"/api-reference/crm-attachments/attach-a-file-to-a-contact"},{"title":"Get attachments for a CRM company","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies/{crmCompanyId}/attachments","href":"/api-reference/crm-attachments/get-attachments-for-a-crm-company"},{"title":"Attach a file to a CRM company","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/companies/{crmCompanyId}/attachments","href":"/api-reference/crm-attachments/attach-a-file-to-a-crm-company"}]},{"group":"CRM Communications","pages":[{"title":"List communications for a deal, contact, or company","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/communications","href":"/api-reference/crm-communications/list-communications-for-a-deal-contact-or-company"},{"title":"Log a communication (call, email, SMS) on a deal, contact, or company","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/communications","href":"/api-reference/crm-communications/log-a-communication-call-email-sms-on-a-deal-contact-or-company"},{"title":"Delete a communication","deprecated":null,"version":null,"openapi":"/openapi.json delete /crm/communications/{id}","href":"/api-reference/crm-communications/delete-a-communication"},{"title":"Update a communication","deprecated":null,"version":null,"openapi":"/openapi.json patch /crm/communications/{id}","href":"/api-reference/crm-communications/update-a-communication"},{"title":"Get communications for a deal","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{dealId}/communications","href":"/api-reference/crm-communications/get-communications-for-a-deal"},{"title":"Log a communication on a deal","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/deals/{dealId}/communications","href":"/api-reference/crm-communications/log-a-communication-on-a-deal"},{"title":"Get communications for a contact","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/contacts/{contactId}/communications","href":"/api-reference/crm-communications/get-communications-for-a-contact"},{"title":"Log a communication on a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/contacts/{contactId}/communications","href":"/api-reference/crm-communications/log-a-communication-on-a-contact"},{"title":"Get communications for a CRM company","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/companies/{crmCompanyId}/communications","href":"/api-reference/crm-communications/get-communications-for-a-crm-company"},{"title":"Log a communication on a CRM company","deprecated":null,"version":null,"openapi":"/openapi.json post /crm/companies/{crmCompanyId}/communications","href":"/api-reference/crm-communications/log-a-communication-on-a-crm-company"}]},{"group":"availability","pages":[{"title":"Get Booking Availability","href":"/api-reference/availability/get-availability"},{"title":"Post availability","deprecated":null,"version":null,"openapi":"/openapi.json post /availability","href":"/api-reference/availability/post-availability"},{"title":"Get many user's availability at once","deprecated":null,"version":null,"openapi":"/openapi.json get /availability/many","href":"/api-reference/availability/get-many-users-availability-at-once"},{"title":"Post availabilitybulk holidays","deprecated":null,"version":null,"openapi":"/openapi.json post /availability/bulk-holidays","href":"/api-reference/availability/post-availabilitybulk-holidays"},{"title":"Get availability meeting types","deprecated":null,"version":null,"openapi":"/openapi.json get /availability/{id}/meeting-types","href":"/api-reference/availability/get-availability-meeting-types"},{"title":"Post availability apply to users","deprecated":null,"version":null,"openapi":"/openapi.json post /availability/{id}/apply-to-users","href":"/api-reference/availability/post-availability-apply-to-users"},{"title":"Get availability 1","deprecated":null,"version":null,"openapi":"/openapi.json get /availability/{id}","href":"/api-reference/availability/get-availability-1"},{"title":"Delete availability","deprecated":null,"version":null,"openapi":"/openapi.json delete /availability/{id}","href":"/api-reference/availability/delete-availability"},{"title":"Patch availability","deprecated":null,"version":null,"openapi":"/openapi.json patch /availability/{id}","href":"/api-reference/availability/patch-availability"},{"title":"Post availabilitydefault","deprecated":null,"version":null,"openapi":"/openapi.json post /availability/default/{availabilityId}","href":"/api-reference/availability/post-availabilitydefault"},{"title":"Patch availability holiday exceptions","deprecated":null,"version":null,"openapi":"/openapi.json patch /availability/{id}/holiday-exceptions","href":"/api-reference/availability/patch-availability-holiday-exceptions"}]},{"group":"availability-exception","pages":[{"title":"Gets user availability exceptions","deprecated":null,"version":null,"openapi":"/openapi.json get /availability-exception/user","href":"/api-reference/availability-exception/gets-user-availability-exceptions"},{"title":"Create user availability exception","deprecated":null,"version":null,"openapi":"/openapi.json post /availability-exception/user","href":"/api-reference/availability-exception/create-user-availability-exception"},{"title":"Update user availability exception","deprecated":null,"version":null,"openapi":"/openapi.json put /availability-exception/{id}","href":"/api-reference/availability-exception/update-user-availability-exception"},{"title":"Delete availability exception","deprecated":null,"version":null,"openapi":"/openapi.json delete /availability-exception/{id}","href":"/api-reference/availability-exception/delete-availability-exception"},{"title":"Gets company availability exceptions","deprecated":null,"version":null,"openapi":"/openapi.json get /availability-exception/company","href":"/api-reference/availability-exception/gets-company-availability-exceptions"},{"title":"Create company availability exception","deprecated":null,"version":null,"openapi":"/openapi.json post /availability-exception/company","href":"/api-reference/availability-exception/create-company-availability-exception"}]},{"group":"WhatsApp V4","pages":[{"title":"Connection test","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/whatsapp/ping","href":"/api-reference/whatsapp-v4/connection-test"},{"title":"Poll for messages","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/whatsapp/messages","href":"/api-reference/whatsapp-v4/poll-for-messages"},{"title":"Send a WhatsApp message","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/whatsapp/messages","href":"/api-reference/whatsapp-v4/send-a-whatsapp-message"},{"title":"List WhatsApp business senders","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/whatsapp/senders","href":"/api-reference/whatsapp-v4/list-whatsapp-business-senders"},{"title":"List message templates","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/whatsapp/templates","href":"/api-reference/whatsapp-v4/list-message-templates"},{"title":"List conversations","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/whatsapp/conversations","href":"/api-reference/whatsapp-v4/list-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/whatsapp/conversations/{id}","href":"/api-reference/whatsapp-v4/get-a-conversation"},{"title":"List messages in a conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/whatsapp/conversations/{id}/messages","href":"/api-reference/whatsapp-v4/list-messages-in-a-conversation"}]},{"group":"Signatures V4","pages":[{"title":"Connection test","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/signatures/ping","href":"/api-reference/signatures-v4/connection-test"},{"title":"This month’s signature usage","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/signatures/usage","href":"/api-reference/signatures-v4/this-month’s-signature-usage"},{"title":"List signature requests","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/signatures","href":"/api-reference/signatures-v4/list-signature-requests"},{"title":"Create a signature request","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/signatures","href":"/api-reference/signatures-v4/create-a-signature-request"},{"title":"Resend a signer invitation","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/signatures/{id}/signers/{signerId}/send","href":"/api-reference/signatures-v4/resend-a-signer-invitation"},{"title":"Get a signature request","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/signatures/{id}","href":"/api-reference/signatures-v4/get-a-signature-request"},{"title":"Cancel a signature request","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/signatures/{id}","href":"/api-reference/signatures-v4/cancel-a-signature-request"},{"title":"Download the signed document","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/signatures/{id}/document","href":"/api-reference/signatures-v4/download-the-signed-document"}]},{"group":"Data Fields","pages":[{"title":"Upload an option-card image; returns a stable public URL to store in\n`options[].image`. Replaces the base64 data-URL workaround that bloated\nthe options jsonb.","deprecated":null,"version":null,"openapi":"/openapi.json post /data-field/option-image","href":"/api-reference/data-fields/upload-an-option-card-image;-returns-a-stable-public-url-to-store-in`options[]image`-replaces-the-base64-data-url-workaround-that-bloatedthe-options-jsonb"},{"title":"Get all data fields","deprecated":null,"version":null,"openapi":"/openapi.json get /data-field","href":"/api-reference/data-fields/get-all-data-fields"},{"title":"Add a new data field","deprecated":null,"version":null,"openapi":"/openapi.json post /data-field","href":"/api-reference/data-fields/add-a-new-data-field"},{"title":"Set the order the fields are read in. Declared before `PATCH :fieldId` so\nNest does not resolve `reorder` as a field id.","deprecated":null,"version":null,"openapi":"/openapi.json patch /data-field/reorder","href":"/api-reference/data-fields/set-the-order-the-fields-are-read-in-declared-before-`patch-:fieldid`-sonest-does-not-resolve-`reorder`-as-a-field-id"},{"title":"Remove a data field","deprecated":null,"version":null,"openapi":"/openapi.json delete /data-field/{fieldId}","href":"/api-reference/data-fields/remove-a-data-field"},{"title":"Update data field","deprecated":null,"version":null,"openapi":"/openapi.json patch /data-field/{fieldId}","href":"/api-reference/data-fields/update-data-field"},{"title":"List every form (within the user's company) that currently references this\nDataField. Used by the field editor to surface \"Used in N forms\" so users\nunderstand the blast radius of an edit.","deprecated":null,"version":null,"openapi":"/openapi.json get /data-field/{fieldId}/usage","href":"/api-reference/data-fields/list-every-form-within-the-users-company-that-currently-references-thisdatafield-used-by-the-field-editor-to-surface-\"used-in-n-forms\"-so-usersunderstand-the-blast-radius-of-an-edit"}]},{"group":"space","pages":[{"title":"Get space","deprecated":null,"version":null,"openapi":"/openapi.json get /space","href":"/api-reference/space/get-space"},{"title":"Post space","deprecated":null,"version":null,"openapi":"/openapi.json post /space","href":"/api-reference/space/post-space"},{"title":"Create a portal with Mira from the operator's brief + client context.\n Generates a tailored layout via the EU gateway; falls back to the\n localized client-portal preset when the gateway is off or the model\n returns nothing usable, so the client context always lands.","deprecated":null,"version":null,"openapi":"/openapi.json get /space/templates","href":"/api-reference/space/create-a-portal-with-mira-from-the-operators-brief-+-client-context-generates-a-tailored-layout-via-the-eu-gateway;-falls-back-to-the-localized-client-portal-preset-when-the-gateway-is-off-or-the-model-returns-nothing-usable-so-the-client-context-always-lands"},{"title":"A working portal from a template, for a client. One transactional copy:\nsections, blocks and content references, progress cleared, the previous\nclient's name and brand swapped for the new one's.","deprecated":null,"version":null,"openapi":"/openapi.json post /space/from-template","href":"/api-reference/space/a-working-portal-from-a-template-for-a-client-one-transactional-copy:sections-blocks-and-content-references-progress-cleared-the-previousclients-name-and-brand-swapped-for-the-new-ones"},{"title":"Get space 1","deprecated":null,"version":null,"openapi":"/openapi.json get /space/{spaceId}","href":"/api-reference/space/get-space-1"},{"title":"Delete space","deprecated":null,"version":null,"openapi":"/openapi.json delete /space/{spaceId}","href":"/api-reference/space/delete-space"},{"title":"Patch space","deprecated":null,"version":null,"openapi":"/openapi.json patch /space/{spaceId}","href":"/api-reference/space/patch-space"},{"title":"Post space publish","deprecated":null,"version":null,"openapi":"/openapi.json post /space/{spaceId}/publish","href":"/api-reference/space/post-space-publish"},{"title":"A same-client copy of a space, \"(Copy)\" suffixed.","deprecated":null,"version":null,"openapi":"/openapi.json post /space/{spaceId}/duplicate","href":"/api-reference/space/a-same-client-copy-of-a-space-\"copy\"-suffixed"},{"title":"Snapshot a space as a reusable template (listed under GET /space/templates).","deprecated":null,"version":null,"openapi":"/openapi.json post /space/{spaceId}/save-as-template","href":"/api-reference/space/snapshot-a-space-as-a-reusable-template-listed-under-get-spacetemplates"},{"title":"Post space section","deprecated":null,"version":null,"openapi":"/openapi.json post /space/{spaceId}/section","href":"/api-reference/space/post-space-section"},{"title":"Insert a saved section template, with all its blocks, in one go.","deprecated":null,"version":null,"openapi":"/openapi.json post /space/{spaceId}/section-from-template","href":"/api-reference/space/insert-a-saved-section-template-with-all-its-blocks-in-one-go"},{"title":"Delete space section","deprecated":null,"version":null,"openapi":"/openapi.json delete /space/{spaceId}/section/{sectionId}","href":"/api-reference/space/delete-space-section"},{"title":"Patch space section","deprecated":null,"version":null,"openapi":"/openapi.json patch /space/{spaceId}/section/{sectionId}","href":"/api-reference/space/patch-space-section"},{"title":"Post space section block","deprecated":null,"version":null,"openapi":"/openapi.json post /space/{spaceId}/section/{sectionId}/block","href":"/api-reference/space/post-space-section-block"},{"title":"Delete space section block","deprecated":null,"version":null,"openapi":"/openapi.json delete /space/{spaceId}/section/{sectionId}/block/{blockId}","href":"/api-reference/space/delete-space-section-block"},{"title":"Patch space section block","deprecated":null,"version":null,"openapi":"/openapi.json patch /space/{spaceId}/section/{sectionId}/block/{blockId}","href":"/api-reference/space/patch-space-section-block"},{"title":"Get space link","deprecated":null,"version":null,"openapi":"/openapi.json get /space/{spaceId}/link","href":"/api-reference/space/get-space-link"},{"title":"Post space link","deprecated":null,"version":null,"openapi":"/openapi.json post /space/{spaceId}/link","href":"/api-reference/space/post-space-link"},{"title":"Delete space link","deprecated":null,"version":null,"openapi":"/openapi.json delete /space/{spaceId}/link/{linkId}","href":"/api-reference/space/delete-space-link"},{"title":"Patch space link","deprecated":null,"version":null,"openapi":"/openapi.json patch /space/{spaceId}/link/{linkId}","href":"/api-reference/space/patch-space-link"},{"title":"Every form block in the space and the submissions that came in through\n it: whether the viewer handed it in, when, and the answers.","deprecated":null,"version":null,"openapi":"/openapi.json get /space/{spaceId}/form-status","href":"/api-reference/space/every-form-block-in-the-space-and-the-submissions-that-came-in-through-it:-whether-the-viewer-handed-it-in-when-and-the-answers"},{"title":"Get space uploads","deprecated":null,"version":null,"openapi":"/openapi.json get /space/{spaceId}/uploads","href":"/api-reference/space/get-space-uploads"},{"title":"Get space uploads download","deprecated":null,"version":null,"openapi":"/openapi.json get /space/{spaceId}/uploads/{uploadId}/download","href":"/api-reference/space/get-space-uploads-download"},{"title":"Get space people","deprecated":null,"version":null,"openapi":"/openapi.json get /space/{spaceId}/people","href":"/api-reference/space/get-space-people"},{"title":"Post space people","deprecated":null,"version":null,"openapi":"/openapi.json post /space/{spaceId}/people","href":"/api-reference/space/post-space-people"},{"title":"Delete space people","deprecated":null,"version":null,"openapi":"/openapi.json delete /space/{spaceId}/people/{inviteId}","href":"/api-reference/space/delete-space-people"},{"title":"Get space section template","deprecated":null,"version":null,"openapi":"/openapi.json get /space-section-template","href":"/api-reference/space/get-space-section-template"},{"title":"Post space section template","deprecated":null,"version":null,"openapi":"/openapi.json post /space-section-template","href":"/api-reference/space/post-space-section-template"},{"title":"Snapshot a live section of one of your spaces as a reusable template.","deprecated":null,"version":null,"openapi":"/openapi.json post /space-section-template/from-section","href":"/api-reference/space/snapshot-a-live-section-of-one-of-your-spaces-as-a-reusable-template"},{"title":"Delete space section template","deprecated":null,"version":null,"openapi":"/openapi.json delete /space-section-template/{templateId}","href":"/api-reference/space/delete-space-section-template"}]},{"group":"Documents","pages":[{"title":"List pages and spreadsheets","deprecated":null,"version":null,"openapi":"/openapi.json get /documents","href":"/api-reference/documents/list-pages-and-spreadsheets"},{"title":"Create a page or spreadsheet","deprecated":null,"version":null,"openapi":"/openapi.json post /documents","href":"/api-reference/documents/create-a-page-or-spreadsheet"},{"title":"Load a document with its content","deprecated":null,"version":null,"openapi":"/openapi.json get /documents/{id}","href":"/api-reference/documents/load-a-document-with-its-content"},{"title":"Delete a document","deprecated":null,"version":null,"openapi":"/openapi.json delete /documents/{id}","href":"/api-reference/documents/delete-a-document"},{"title":"Save document content and/or title","deprecated":null,"version":null,"openapi":"/openapi.json patch /documents/{id}","href":"/api-reference/documents/save-document-content-andor-title"}]},{"group":"Invoicing Sellers","pages":[{"title":"Get invoicingseller profiles","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/seller-profiles","href":"/api-reference/invoicing-sellers/get-invoicingseller-profiles"},{"title":"Post invoicingseller profiles","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/seller-profiles","href":"/api-reference/invoicing-sellers/post-invoicingseller-profiles"},{"title":"Get invoicingseller profiles 1","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/seller-profiles/{id}","href":"/api-reference/invoicing-sellers/get-invoicingseller-profiles-1"},{"title":"Delete invoicingseller profiles","deprecated":null,"version":null,"openapi":"/openapi.json delete /invoicing/seller-profiles/{id}","href":"/api-reference/invoicing-sellers/delete-invoicingseller-profiles"},{"title":"Patch invoicingseller profiles","deprecated":null,"version":null,"openapi":"/openapi.json patch /invoicing/seller-profiles/{id}","href":"/api-reference/invoicing-sellers/patch-invoicingseller-profiles"},{"title":"Post invoicingseller profiles archive","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/seller-profiles/{id}/archive","href":"/api-reference/invoicing-sellers/post-invoicingseller-profiles-archive"},{"title":"Post invoicingseller profiles restore","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/seller-profiles/{id}/restore","href":"/api-reference/invoicing-sellers/post-invoicingseller-profiles-restore"}]},{"group":"Invoicing Branches","pages":[{"title":"Get invoicingbranches","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/branches","href":"/api-reference/invoicing-branches/get-invoicingbranches"},{"title":"Post invoicingbranches","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/branches","href":"/api-reference/invoicing-branches/post-invoicingbranches"},{"title":"Get invoicingbranches 1","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/branches/{id}","href":"/api-reference/invoicing-branches/get-invoicingbranches-1"},{"title":"Delete invoicingbranches","deprecated":null,"version":null,"openapi":"/openapi.json delete /invoicing/branches/{id}","href":"/api-reference/invoicing-branches/delete-invoicingbranches"},{"title":"Patch invoicingbranches","deprecated":null,"version":null,"openapi":"/openapi.json patch /invoicing/branches/{id}","href":"/api-reference/invoicing-branches/patch-invoicingbranches"},{"title":"Post invoicingbranches archive","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/branches/{id}/archive","href":"/api-reference/invoicing-branches/post-invoicingbranches-archive"},{"title":"Post invoicingbranches restore","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/branches/{id}/restore","href":"/api-reference/invoicing-branches/post-invoicingbranches-restore"}]},{"group":"Invoicing Products","pages":[{"title":"Get invoicingproducts","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/products","href":"/api-reference/invoicing-products/get-invoicingproducts"},{"title":"Post invoicingproducts","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/products","href":"/api-reference/invoicing-products/post-invoicingproducts"},{"title":"Get invoicingproducts 1","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/products/{id}","href":"/api-reference/invoicing-products/get-invoicingproducts-1"},{"title":"Delete invoicingproducts","deprecated":null,"version":null,"openapi":"/openapi.json delete /invoicing/products/{id}","href":"/api-reference/invoicing-products/delete-invoicingproducts"},{"title":"Patch invoicingproducts","deprecated":null,"version":null,"openapi":"/openapi.json patch /invoicing/products/{id}","href":"/api-reference/invoicing-products/patch-invoicingproducts"}]},{"group":"Invoicing Settings","pages":[{"title":"Get invoicingsettings","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/settings","href":"/api-reference/invoicing-settings/get-invoicingsettings"},{"title":"Put invoicingsettings","deprecated":null,"version":null,"openapi":"/openapi.json put /invoicing/settings","href":"/api-reference/invoicing-settings/put-invoicingsettings"},{"title":"Get invoicingbank accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/bank-accounts","href":"/api-reference/invoicing-settings/get-invoicingbank-accounts"},{"title":"Post invoicingbank accounts","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/bank-accounts","href":"/api-reference/invoicing-settings/post-invoicingbank-accounts"},{"title":"Delete invoicingbank accounts","deprecated":null,"version":null,"openapi":"/openapi.json delete /invoicing/bank-accounts/{id}","href":"/api-reference/invoicing-settings/delete-invoicingbank-accounts"},{"title":"Patch invoicingbank accounts","deprecated":null,"version":null,"openapi":"/openapi.json patch /invoicing/bank-accounts/{id}","href":"/api-reference/invoicing-settings/patch-invoicingbank-accounts"},{"title":"","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/number-ranges","href":"/api-reference/invoicing-settings/get-invoicingnumber-ranges"},{"title":"","deprecated":null,"version":null,"openapi":"/openapi.json put /invoicing/number-ranges/{kind}","href":"/api-reference/invoicing-settings/put-invoicingnumber-ranges"}]},{"group":"Invoicing Recurring","pages":[{"title":"Buyer fields for an invoice, taken from a CRM company","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/buyer-prefill/company/{crmCompanyId}","href":"/api-reference/invoicing-recurring/buyer-fields-for-an-invoice-taken-from-a-crm-company"},{"title":"Contacts of a CRM company, for the buyer picker","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/buyer-prefill/company/{crmCompanyId}/contacts","href":"/api-reference/invoicing-recurring/contacts-of-a-crm-company-for-the-buyer-picker"},{"title":"Which completed meetings a customer had in the period, priced as lines","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/billing-runs/preview","href":"/api-reference/invoicing-recurring/which-completed-meetings-a-customer-had-in-the-period-priced-as-lines"},{"title":"Draft invoice over those meetings; opens in the editor for review","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/billing-runs","href":"/api-reference/invoicing-recurring/draft-invoice-over-those-meetings;-opens-in-the-editor-for-review"},{"title":"ZIP download: EXTF Buchungsstapel CSV + document PDFs of the period","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/datev/export","href":"/api-reference/invoicing-recurring/zip-download:-extf-buchungsstapel-csv-+-document-pdfs-of-the-period"},{"title":"One-click Steuerberater handoff: email the export ZIP to the advisor.\nThrottled hard — this is a monthly action that builds and mails a whole\nperiod's documents, so a loop here is expensive on both sides.","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/datev/send","href":"/api-reference/invoicing-recurring/one-click-steuerberater-handoff:-email-the-export-zip-to-the-advisorthrottled-hard-—-this-is-a-monthly-action-that-builds-and-mails-a-wholeperiods-documents-so-a-loop-here-is-expensive-on-both-sides"},{"title":"Get invoicingrecurring","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/recurring","href":"/api-reference/invoicing-recurring/get-invoicingrecurring"},{"title":"Post invoicingrecurring","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/recurring","href":"/api-reference/invoicing-recurring/post-invoicingrecurring"},{"title":"Get invoicingrecurring 1","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/recurring/{id}","href":"/api-reference/invoicing-recurring/get-invoicingrecurring-1"},{"title":"Delete invoicingrecurring","deprecated":null,"version":null,"openapi":"/openapi.json delete /invoicing/recurring/{id}","href":"/api-reference/invoicing-recurring/delete-invoicingrecurring"},{"title":"Patch invoicingrecurring","deprecated":null,"version":null,"openapi":"/openapi.json patch /invoicing/recurring/{id}","href":"/api-reference/invoicing-recurring/patch-invoicingrecurring"}]},{"group":"Invoicing Documents","pages":[{"title":"Get invoicingdocuments","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/documents","href":"/api-reference/invoicing-documents/get-invoicingdocuments"},{"title":"Post invoicingdocuments","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents","href":"/api-reference/invoicing-documents/post-invoicingdocuments"},{"title":"Get invoicingdocuments 1","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/documents/{id}","href":"/api-reference/invoicing-documents/get-invoicingdocuments-1"},{"title":"Delete invoicingdocuments","deprecated":null,"version":null,"openapi":"/openapi.json delete /invoicing/documents/{id}","href":"/api-reference/invoicing-documents/delete-invoicingdocuments"},{"title":"Patch invoicingdocuments","deprecated":null,"version":null,"openapi":"/openapi.json patch /invoicing/documents/{id}","href":"/api-reference/invoicing-documents/patch-invoicingdocuments"},{"title":"Post invoicingdocuments finalize","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/finalize","href":"/api-reference/invoicing-documents/post-invoicingdocuments-finalize"},{"title":"Post invoicingdocuments send","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/send","href":"/api-reference/invoicing-documents/post-invoicingdocuments-send"},{"title":"WhatsApp template delivery; the message links to the hosted pay page","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/send-whatsapp","href":"/api-reference/invoicing-documents/whatsapp-template-delivery;-the-message-links-to-the-hosted-pay-page"},{"title":"Post invoicingdocuments duplicate","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/duplicate","href":"/api-reference/invoicing-documents/post-invoicingdocuments-duplicate"},{"title":"Post invoicingdocuments convert to invoice","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/convert-to-invoice","href":"/api-reference/invoicing-documents/post-invoicingdocuments-convert-to-invoice"},{"title":"Post invoicingdocuments offer status","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/offer-status","href":"/api-reference/invoicing-documents/post-invoicingdocuments-offer-status"},{"title":"Post invoicingdocuments cancel","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/cancel","href":"/api-reference/invoicing-documents/post-invoicingdocuments-cancel"},{"title":"Get invoicingdocuments events","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/documents/{id}/events","href":"/api-reference/invoicing-documents/get-invoicingdocuments-events"},{"title":"Get invoicingdocuments preview","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/documents/{id}/preview","href":"/api-reference/invoicing-documents/get-invoicingdocuments-preview"},{"title":"Get invoicingdocuments download","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/documents/{id}/download/{type}","href":"/api-reference/invoicing-documents/get-invoicingdocuments-download"},{"title":"Get invoicingdocuments payments","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/documents/{id}/payments","href":"/api-reference/invoicing-documents/get-invoicingdocuments-payments"},{"title":"Post invoicingdocuments payments","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/payments","href":"/api-reference/invoicing-documents/post-invoicingdocuments-payments"},{"title":"Delete invoicingdocuments payments","deprecated":null,"version":null,"openapi":"/openapi.json delete /invoicing/documents/{id}/payments/{paymentId}","href":"/api-reference/invoicing-documents/delete-invoicingdocuments-payments"},{"title":"Hosted pay-page URL for finalized invoices (copy button in the UI)","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/documents/{id}/payment-link","href":"/api-reference/invoicing-documents/hosted-pay-page-url-for-finalized-invoices-copy-button-in-the-ui"},{"title":"Exclude/include this invoice from dunning auto-send","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/dunning-pause","href":"/api-reference/invoicing-documents/excludeinclude-this-invoice-from-dunning-auto-send"},{"title":"Invoice → editable Gutschrift draft over all or selected lines","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/credit-note","href":"/api-reference/invoicing-documents/invoice-→-editable-gutschrift-draft-over-all-or-selected-lines"},{"title":"How much of an invoice is already credited, and what is still open","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/documents/{id}/credit-notes","href":"/api-reference/invoicing-documents/how-much-of-an-invoice-is-already-credited-and-what-is-still-open"},{"title":"Gutschrift draft → issued document + receivable offset","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/credit-notes/{id}/issue","href":"/api-reference/invoicing-documents/gutschrift-draft-→-issued-document-+-receivable-offset"},{"title":"","deprecated":null,"version":null,"openapi":"/openapi.json get /invoicing/documents/{id}/dunning/preview","href":"/api-reference/invoicing-documents/get-invoicingdocuments-dunningpreview"},{"title":"Sends mail on the company letterhead; throttled like the other send paths.","deprecated":null,"version":null,"openapi":"/openapi.json post /invoicing/documents/{id}/dunning/send","href":"/api-reference/invoicing-documents/sends-mail-on-the-company-letterhead;-throttled-like-the-other-send-paths"}]},{"group":"Partner API","pages":[{"title":"List your customer workspaces","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /v4/partner/customers","href":"/api-reference/partner-api/list-your-customer-workspaces"},{"title":"Create a customer workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/partner/customers","href":"/api-reference/partner-api/create-a-customer-workspace"},{"title":"Get one customer workspace","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /v4/partner/customers/{companyId}","href":"/api-reference/partner-api/get-one-customer-workspace"},{"title":"Update a customer workspace","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/partner/customers/{companyId}","href":"/api-reference/partner-api/update-a-customer-workspace"},{"title":"Get a workspace token","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/partner/customers/{companyId}/token","href":"/api-reference/partner-api/get-a-workspace-token"},{"title":"List the users of a customer workspace","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/partner/customers/{companyId}/users","href":"/api-reference/partner-api/list-the-users-of-a-customer-workspace"},{"title":"Invite users to a customer workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/partner/customers/{companyId}/users","href":"/api-reference/partner-api/invite-users-to-a-customer-workspace"},{"title":"Remove a user from a customer workspace","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/partner/customers/{companyId}/users/{userId}","href":"/api-reference/partner-api/remove-a-user-from-a-customer-workspace"},{"title":"Billing summary","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/partner/billing/summary","href":"/api-reference/partner-api/billing-summary"},{"title":"List Refer commission entries","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/partner/commissions","href":"/api-reference/partner-api/list-refer-commission-entries"},{"title":"Commission totals: held, available, paid","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/partner/commissions/summary","href":"/api-reference/partner-api/commission-totals:-held-available-paid"}]},{"group":"CRM Email Sync","pages":[{"title":"Get synced emails for a CRM contact","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/contacts/{contactId}/emails","href":"/api-reference/crm-email-sync/get-synced-emails-for-a-crm-contact"},{"title":"Get synced emails for a CRM deal","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/deals/{dealId}/emails","href":"/api-reference/crm-email-sync/get-synced-emails-for-a-crm-deal"},{"title":"Fetch full email body on-demand from provider","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/emails/{id}/body","href":"/api-reference/crm-email-sync/fetch-full-email-body-on-demand-from-provider"},{"title":"Whether the current user can send from their own mailbox","deprecated":null,"version":null,"openapi":"/openapi.json get /crm/emails/send-capability","href":"/api-reference/crm-email-sync/whether-the-current-user-can-send-from-their-own-mailbox"}]},{"group":"Meeting Type V4","pages":[{"title":"Get meeting types","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/meeting-type","href":"/api-reference/meeting-type-v4/get-meeting-types"},{"title":"Create meeting type","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/meeting-type","href":"/api-reference/meeting-type-v4/create-meeting-type"},{"title":"Get meeting type information","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/meeting-type/{id}","href":"/api-reference/meeting-type-v4/get-meeting-type-information"},{"title":"Delete meeting type","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/meeting-type/{id}","href":"/api-reference/meeting-type-v4/delete-meeting-type"},{"title":"Update meeting type","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/meeting-type/{id}","href":"/api-reference/meeting-type-v4/update-meeting-type"}]},{"group":"Booking Availability V4","pages":[{"title":"Get booking availability for a meeting type","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-availability","href":"/api-reference/booking-availability-v4/get-booking-availability-for-a-meeting-type"},{"title":"Get user availability for a specific timeframe","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-availability/user/{id}/timeframe","href":"/api-reference/booking-availability-v4/get-user-availability-for-a-specific-timeframe"}]},{"group":"Queue V4","pages":[{"title":"Update queue for a meeting type","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/queue/meeting-type/{meetingTypeId}","href":"/api-reference/queue-v4/update-queue-for-a-meeting-type"},{"title":"Get all queues for a workspace","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/queue/workspace/{workspaceId}","href":"/api-reference/queue-v4/get-all-queues-for-a-workspace"},{"title":"Get all queues for a company","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/queue/company","href":"/api-reference/queue-v4/get-all-queues-for-a-company"},{"title":"Get queue by ID","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/queue/{queueId}","href":"/api-reference/queue-v4/get-queue-by-id"},{"title":"Get next available hosts from queue","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/queue/{queueId}/next","href":"/api-reference/queue-v4/get-next-available-hosts-from-queue"}]},{"group":"Queue User Group V4","pages":[{"title":"Create a new user group","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/queue-user-group","href":"/api-reference/queue-user-group-v4/create-a-new-user-group"},{"title":"Delete a user group","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/queue-user-group/{groupId}","href":"/api-reference/queue-user-group-v4/delete-a-user-group"},{"title":"Update an existing user group","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/queue-user-group/{groupId}","href":"/api-reference/queue-user-group-v4/update-an-existing-user-group"}]},{"group":"Meeting Type Template V4","pages":[{"title":"Create a new meeting type template","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/meeting-type-template/create","href":"/api-reference/meeting-type-template-v4/create-a-new-meeting-type-template"},{"title":"Assign host to meeting type template","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/meeting-type-template/assign/{templateId}","href":"/api-reference/meeting-type-template-v4/assign-host-to-meeting-type-template"},{"title":"Assign multiple hosts to meeting type template","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/meeting-type-template/assign-bulk/{templateId}","href":"/api-reference/meeting-type-template-v4/assign-multiple-hosts-to-meeting-type-template"},{"title":"Unassign host from meeting type template","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/meeting-type-template/unassign/{templateId}","href":"/api-reference/meeting-type-template-v4/unassign-host-from-meeting-type-template"},{"title":"Get all meeting type templates for user","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/meeting-type-template/all","href":"/api-reference/meeting-type-template-v4/get-all-meeting-type-templates-for-user"},{"title":"Get meeting type template by ID","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/meeting-type-template/{id}","href":"/api-reference/meeting-type-template-v4/get-meeting-type-template-by-id"},{"title":"Delete a meeting type template","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/meeting-type-template/{id}","href":"/api-reference/meeting-type-template-v4/delete-a-meeting-type-template"},{"title":"Update a meeting type template","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/meeting-type-template/{id}","href":"/api-reference/meeting-type-template-v4/update-a-meeting-type-template"},{"title":"Get meeting types created from this template","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/meeting-type-template/users/{templateId}","href":"/api-reference/meeting-type-template-v4/get-meeting-types-created-from-this-template"},{"title":"Assign team template to workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/meeting-type-template/assign-workspace/{templateId}","href":"/api-reference/meeting-type-template-v4/assign-team-template-to-workspace"},{"title":"Get workspaces assigned to this template","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/meeting-type-template/workspaces/{templateId}","href":"/api-reference/meeting-type-template-v4/get-workspaces-assigned-to-this-template"}]},{"group":"One Time Booking Link V4","pages":[{"title":"Create a one-time booking link for a meeting type","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/one-time-booking-link/create/{meetingTypeId}","href":"/api-reference/one-time-booking-link-v4/create-a-one-time-booking-link-for-a-meeting-type"}]},{"group":"Provisional Booking V4","pages":[{"title":"Get paginated provisional bookings","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/provisional-booking/paginated","href":"/api-reference/provisional-booking-v4/get-paginated-provisional-bookings"},{"title":"Delete provisional booking","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/provisional-booking/{id}","href":"/api-reference/provisional-booking-v4/delete-provisional-booking"},{"title":"Decline provisional booking","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/provisional-booking/{id}/decline","href":"/api-reference/provisional-booking-v4/decline-provisional-booking"}]},{"group":"Handoff V4","pages":[{"title":"Handoff appointment to another user or queue","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/handoff/appointment","href":"/api-reference/handoff-v4/handoff-appointment-to-another-user-or-queue"},{"title":"Get available handoff options","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/handoff/available-handoffs","href":"/api-reference/handoff-v4/get-available-handoff-options"},{"title":"Bulk handoff appointments","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/handoff/bulk","href":"/api-reference/handoff-v4/bulk-handoff-appointments"}]},{"group":"Booking Link V4","pages":[{"title":"Create a group booking link","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/booking-link/group","href":"/api-reference/booking-link-v4/create-a-group-booking-link"},{"title":"Delete a group booking link","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/booking-link/group/{groupBookingLinkId}","href":"/api-reference/booking-link-v4/delete-a-group-booking-link"},{"title":"Update a group booking link","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/booking-link/group/{groupBookingLinkId}","href":"/api-reference/booking-link-v4/update-a-group-booking-link"},{"title":"Get group booking links of a workspace","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-link/group/workspace/{workspaceId}","href":"/api-reference/booking-link-v4/get-group-booking-links-of-a-workspace"},{"title":"Get booking links for specified workspace or user workspace","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-link","href":"/api-reference/booking-link-v4/get-booking-links-for-specified-workspace-or-user-workspace"},{"title":"Get all booking links with scopes","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-link/all","href":"/api-reference/booking-link-v4/get-all-booking-links-with-scopes"},{"title":"Get meeting types assigned to requesters personal booking link","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-link/personal-link/assigned","href":"/api-reference/booking-link-v4/get-meeting-types-assigned-to-requesters-personal-booking-link"},{"title":"Get personal booking link page data","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-link/personal-link/{companySlug}/{userSlug}","href":"/api-reference/booking-link-v4/get-personal-booking-link-page-data"},{"title":"Get company booking link page data","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-link/company/{companySlug}","href":"/api-reference/booking-link-v4/get-company-booking-link-page-data"},{"title":"Get a link for personal page","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-link/personal-page/link","href":"/api-reference/booking-link-v4/get-a-link-for-personal-page"},{"title":"Get personal page data","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-link/personal-page/v2/{userSlug}","href":"/api-reference/booking-link-v4/get-personal-page-data"},{"title":"Get booking link for specified meeting type","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/booking-link/user/{userId}/meetingType/{meetingTypeId}","href":"/api-reference/booking-link-v4/get-booking-link-for-specified-meeting-type"}]},{"group":"Booking V4","pages":[{"title":"Confirm appointment cancellation","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/booking/confirm/cancel/{appointmentId}/{secret}","href":"/api-reference/booking-v4/confirm-appointment-cancellation"},{"title":"Create appointment booking","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/booking","href":"/api-reference/booking-v4/create-appointment-booking"}]},{"group":"appointment","pages":[{"title":"Draft a follow-up email from a meeting-s notes","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/appointment/{appointmentId}/follow-up-draft","href":"/api-reference/appointment/draft-a-follow-up-email-from-a-meeting-s-notes"},{"title":"Make this meeting-s recap readable by link","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/appointment/{appointmentId}/recap/share","href":"/api-reference/appointment/make-this-meeting-s-recap-readable-by-link"},{"title":"Revoke the recap link","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/appointment/{appointmentId}/recap/unshare","href":"/api-reference/appointment/revoke-the-recap-link"},{"title":"Email a meeting's notes to a chosen address","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/meeting-transcript/email","href":"/api-reference/appointment/email-a-meetings-notes-to-a-chosen-address"}]},{"group":"Attendee V4","pages":[{"title":"Mark attendee as no-show","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/attendee/no-show/{attendeeId}","href":"/api-reference/attendee-v4/mark-attendee-as-no-show"},{"title":"Send quick email to attendee","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/attendee/quick-mail","href":"/api-reference/attendee-v4/send-quick-email-to-attendee"},{"title":"Update attendee notes","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/attendee/{attendeeId}/notes","href":"/api-reference/attendee-v4/update-attendee-notes"}]},{"group":"Appointment V4","pages":[{"title":"Get public appointment details","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/appointment/public/{appointmentId}","href":"/api-reference/appointment-v4/get-public-appointment-details"},{"title":"Get paginated appointments","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/appointment/paginated","href":"/api-reference/appointment-v4/get-paginated-appointments"},{"title":"Delete appointment","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/appointment/{appointmentId}","href":"/api-reference/appointment-v4/delete-appointment"},{"title":"Get today's appointments","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/appointment/today","href":"/api-reference/appointment-v4/get-todays-appointments"},{"title":"Get current appointment","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/appointment/current","href":"/api-reference/appointment-v4/get-current-appointment"},{"title":"Get appointment by ID","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/appointment/{id}","href":"/api-reference/appointment-v4/get-appointment-by-id"},{"title":"Remove guest email from appointment","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/appointment/{appointmentId}/guest","href":"/api-reference/appointment-v4/remove-guest-email-from-appointment"},{"title":"Add guest emails to appointment","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/appointment/{appointmentId}/guest","href":"/api-reference/appointment-v4/add-guest-emails-to-appointment"},{"title":"Update appointment notes","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/appointment/{appointmentId}/notes","href":"/api-reference/appointment-v4/update-appointment-notes"},{"title":"Update meeting transcription and summary","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/appointment/{appointmentId}/transcription","href":"/api-reference/appointment-v4/update-meeting-transcription-and-summary"},{"title":"Cancel an appointment","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/appointment/{id}/cancel","href":"/api-reference/appointment-v4/cancel-an-appointment"},{"title":"Reschedule an appointment","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/appointment/{id}/reschedule","href":"/api-reference/appointment-v4/reschedule-an-appointment"}]},{"group":"Attendee Pending V4","pages":[{"title":"Get pending attendees","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/attendee/pending","href":"/api-reference/attendee-pending-v4/get-pending-attendees"},{"title":"Create pending attendee","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/attendee/pending","href":"/api-reference/attendee-pending-v4/create-pending-attendee"},{"title":"Update pending attendee","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/attendee/pending/{id}","href":"/api-reference/attendee-pending-v4/update-pending-attendee"}]},{"group":"Personal Page V4","pages":[{"title":"Get personal page of the requesting user","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/personal-page/me","href":"/api-reference/personal-page-v4/get-personal-page-of-the-requesting-user"},{"title":"Update personal page of the requesting user","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/personal-page/me","href":"/api-reference/personal-page-v4/update-personal-page-of-the-requesting-user"},{"title":"Get personal page by user ID (admin only)","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/personal-page/{id}","href":"/api-reference/personal-page-v4/get-personal-page-by-user-id-admin-only"},{"title":"Update personal page by user ID (admin only)","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/personal-page/{id}","href":"/api-reference/personal-page-v4/update-personal-page-by-user-id-admin-only"},{"title":"Update personal page header picture","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/personal-page/header-picture","href":"/api-reference/personal-page-v4/update-personal-page-header-picture"}]},{"group":"User V4","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/user","href":"/api-reference/user-v4/list-users"},{"title":"Create platform user","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/user","href":"/api-reference/user-v4/create-platform-user"},{"title":"Get current user information","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/user/me","href":"/api-reference/user-v4/get-current-user-information"},{"title":"Get user information","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/user/{id}","href":"/api-reference/user-v4/get-user-information"},{"title":"Delete a user","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/user/{id}","href":"/api-reference/user-v4/delete-a-user"},{"title":"Update platform user","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/user/{id}","href":"/api-reference/user-v4/update-platform-user"},{"title":"Update user calendar sync provider","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/user/{id}/calendar-sync","href":"/api-reference/user-v4/update-user-calendar-sync-provider"}]},{"group":"Calendar Auth V4","pages":[{"title":"Get OAuth authorization URL","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/calendar-connections/auth/{provider}/url","href":"/api-reference/calendar-auth-v4/get-oauth-authorization-url"},{"title":"OAuth callback handler","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/calendar-connections/auth/{provider}/callback","href":"/api-reference/calendar-auth-v4/oauth-callback-handler"}]},{"group":"Calendar Connections V4","pages":[{"title":"List calendar connections","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/calendar-connections/connections","href":"/api-reference/calendar-connections-v4/list-calendar-connections"},{"title":"Delete calendar connection","deprecated":null,"version":null,"openapi":"/openapi.json delete /v4/calendar-connections/connections/{connectionId}","href":"/api-reference/calendar-connections-v4/delete-calendar-connection"},{"title":"Update calendar connection","deprecated":null,"version":null,"openapi":"/openapi.json patch /v4/calendar-connections/connections/{connectionId}","href":"/api-reference/calendar-connections-v4/update-calendar-connection"},{"title":"Set connection as primary","deprecated":null,"version":null,"openapi":"/openapi.json post /v4/calendar-connections/connections/{connectionId}/set-primary","href":"/api-reference/calendar-connections-v4/set-connection-as-primary"},{"title":"Get connection calendars","deprecated":null,"version":null,"openapi":"/openapi.json get /v4/calendar-connections/connections/{connectionId}/calendars","href":"/api-reference/calendar-connections-v4/get-connection-calendars"}]}]}]},"basePath":"","title":"Create a customer workspace - meetergo","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CxAy5y67.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}