{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Planpoint Viewer Docs","colors":{"primary":"#0f68ea","light":"#f0f2f4","dark":"#0f68ea"},"logo":{"light":"https://mintcdn.com/planpoint/ygbSuV-niiq46Suq/logo/light.svg?fit=max\u0026auto=format\u0026n=ygbSuV-niiq46Suq\u0026q=85\u0026s=7799fb568d5d530467492a989784f18f","dark":"https://mintcdn.com/planpoint/nX9odRMiqNApqjCO/logo/dark.svg?fit=max\u0026auto=format\u0026n=nX9odRMiqNApqjCO\u0026q=85\u0026s=675e18f4bdd6a73fbb28bac2c6dfb407"},"favicon":"https://mintcdn.com/planpoint/nX9odRMiqNApqjCO/favicon.svg?fit=max\u0026auto=format\u0026n=nX9odRMiqNApqjCO\u0026q=85\u0026s=4e4b98d26a99a5cb92a601bb8d469c83","navbar":{"links":[{"href":"mailto:support@planpoint.io","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.planpoint.io/login"}},"footer":{"socials":{"instagram":"https://www.instagram.com/planpoint.io","linkedin":"https://www.linkedin.com/company/68575632","github":"https://github.com/"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"planpoint","hasAudioNarration":false,"actualSubdomain":"planpoint","customDomains":["viewerdocs.planpoint.io"],"gitSource":{"type":"github","owner":"planpoint-io","repo":"planpoint-viewerdocs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad240b87414c95fc10fe53f","collectionId":"e116f7be-2851-481e-bb2b-d296c3a0caae","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad240b87414c95fc10fe53f"},"entitlements":{},"buildId":"6ad240b87414c95fc10fe53f","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Documentation","count":62},{"language":"default","tag":"General","count":36},{"language":"default","tag":"Advanced Features","count":21},{"language":"default","tag":"API ","count":20},{"language":"default","tag":"Creation","count":10},{"language":"default","tag":"SDK","count":6},{"language":"default","tag":"SDK Documentation","count":6},{"language":"default","tag":"Units","count":5},{"language":"default","tag":"Editing and Management","count":5},{"language":"default","tag":"Floors","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-documentation/endpoint/groups/id/get","slug":"/api-documentation/endpoint/groups/id/get","pageMetadata":{"title":"Get Group","openapi":"GET /groups/{id}","description":"Fetch a group","href":"/api-documentation/endpoint/groups/id/get"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Fetch a group\"\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":"Get Group","openapi":"GET /groups/{id}","description":"Fetch a group","href":"/api-documentation/endpoint/groups/id/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["groups"],"summary":"Search for a group","description":"Fetch a group","operationId":"fetchGroup","parameters":["256d0454-b765-434f-b61f-9dbb8a5dce82"],"responses":{"200":"92297eb0-1d3e-4be6-b093-99e1cbdd1fcc","400":"75708b89-c122-4e77-9706-5fe0783f2dcb"},"method":"get","type":"path","servers":["7bb825c7-18c0-4f48-bb86-e5034be31eda"],"security":["e22ac421-51f4-431d-bcc1-10cead503d0f"],"path":"/groups/{id}","baseUrlOptions":["https://app.planpoint.io/api"],"title":"Search for a group","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"256d0454-b765-434f-b61f-9dbb8a5dce82":{"name":"id","in":"path","description":"Group ID","required":true,"schema":{"type":"string","example":"objectId","isRequired":true,"description":"Group ID","uniqueKey":"","typeLabel":"string"}}},"responses":{"92297eb0-1d3e-4be6-b093-99e1cbdd1fcc":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"_id":{"type":"string","format":"objectId","description":"The unique identifier for the group.","example":"objectId","uniqueKey":"_id","typeLabel":"string\u003cobjectId>"},"user":{"type":"string","format":"objectId","description":"Reference to the user who owns the group.","example":"objectId","uniqueKey":"user","typeLabel":"string\u003cobjectId>"},"name":{"type":"string","description":"Name of the group.","uniqueKey":"name","typeLabel":"string"},"websiteURL":{"type":"string","format":"uri","description":"URL of the group's website.","uniqueKey":"websiteURL","typeLabel":"string\u003curi>"},"showAvailableFirst":{"type":"boolean","default":false,"description":"Whether to prioritize showing available items first.","uniqueKey":"showAvailableFirst","typeLabel":"boolean"},"projects":{"type":"array","items":{"type":"string","format":"objectId","description":"ID of an associated project.","example":"objectId","uniqueKey":"projects.items.[INDEX]","typeLabel":"string\u003cobjectId>"},"uniqueKey":"projects","typeLabel":"string\u003cobjectId>[]"},"namespace":{"type":"string","description":"Namespace for the group.","uniqueKey":"namespace","typeLabel":"string"},"hostName":{"type":"string","description":"Hostname of the group.","uniqueKey":"hostName","typeLabel":"string"},"groupLang":{"type":"string","default":"en","description":"Language setting for the group.","uniqueKey":"groupLang","typeLabel":"string"},"linkBehavior":{"type":"string","default":"Planpoint","description":"Default link behavior.","uniqueKey":"linkBehavior","typeLabel":"string"},"accentColor":{"type":"string","description":"Accent color of the group.","uniqueKey":"accentColor","typeLabel":"string"},"groupImageUrl":{"type":"string","format":"uri","description":"URL of the group's image.","uniqueKey":"groupImageUrl","typeLabel":"string\u003curi>"},"groupSVGUrl":{"type":"string","format":"uri","description":"URL of the group's SVG.","uniqueKey":"groupSVGUrl","typeLabel":"string\u003curi>"},"svgGroupId":{"type":"string","description":"SVG group identifier.","uniqueKey":"svgGroupId","typeLabel":"string"},"address":{"type":"string","description":"Physical address of the group.","uniqueKey":"address","typeLabel":"string"},"lon":{"type":"number","format":"double","description":"Longitude of the group location.","example":-93.75940812944687,"uniqueKey":"lon","typeLabel":"number\u003cdouble>"},"lat":{"type":"number","format":"double","description":"Latitude of the group location.","example":43.75940812944687,"uniqueKey":"lat","typeLabel":"number\u003cdouble>"},"zoomLevel":{"type":"number","default":0,"description":"Default map zoom level.","uniqueKey":"zoomLevel","typeLabel":"number"},"administrators":{"type":"array","items":{"type":"string","format":"objectId","description":"ID of an administrator user.","example":"objectId","uniqueKey":"administrators.items.[INDEX]","typeLabel":"string\u003cobjectId>"},"uniqueKey":"administrators","typeLabel":"string\u003cobjectId>[]"},"editors":{"type":"array","items":{"type":"string","format":"objectId","description":"ID of an editor user.","example":"objectId","uniqueKey":"editors.items.[INDEX]","typeLabel":"string\u003cobjectId>"},"uniqueKey":"editors","typeLabel":"string\u003cobjectId>[]"},"invites":{"type":"array","items":{"type":"object","properties":{"firstName":{"type":"string","uniqueKey":"invites.items.[INDEX].firstName","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"invites.items.[INDEX].lastName","typeLabel":"string"},"email":{"type":"string","format":"email","uniqueKey":"invites.items.[INDEX].email","typeLabel":"string\u003cemail>"},"level":{"type":"string","uniqueKey":"invites.items.[INDEX].level","typeLabel":"string"}},"uniqueKey":"invites.items.[INDEX]","typeLabel":"object"},"description":"List of invited users.","uniqueKey":"invites","typeLabel":"object[]"},"perimeter":{"type":"string","description":"Perimeter of the group area.","uniqueKey":"perimeter","typeLabel":"string"},"markerImageUrl":{"type":"string","format":"uri","description":"URL of the marker image.","uniqueKey":"markerImageUrl","typeLabel":"string\u003curi>"},"targetMarker":{"type":"string","description":"Target marker identifier.","uniqueKey":"targetMarker","typeLabel":"string"},"mapStyle":{"type":"string","default":"Light","description":"Style of the map.","uniqueKey":"mapStyle","typeLabel":"string"},"mapPointColor":{"type":"string","description":"Color of map points.","uniqueKey":"mapPointColor","typeLabel":"string"},"showAllUnits":{"type":"boolean","description":"Whether to display all units.","uniqueKey":"showAllUnits","typeLabel":"boolean"},"showPrices":{"type":"boolean","description":"Whether to display prices.","uniqueKey":"showPrices","typeLabel":"boolean"},"initialView":{"type":"string","default":"List","description":"Initial view of the group.","uniqueKey":"initialView","typeLabel":"string"},"unitImageOnGrid":{"type":"string","default":"Unit Plan","description":"Image type shown on the grid.","uniqueKey":"unitImageOnGrid","typeLabel":"string"},"pricesStartingAt":{"type":"boolean","default":false,"description":"Whether to show prices starting at a certain value.","uniqueKey":"pricesStartingAt","typeLabel":"boolean"},"showTaxes":{"type":"boolean","description":"Whether to show taxes.","uniqueKey":"showTaxes","typeLabel":"boolean"},"priceBeforeTax":{"type":"boolean","description":"Whether the price is shown before tax.","uniqueKey":"priceBeforeTax","typeLabel":"boolean"},"showAvailability":{"type":"boolean","description":"Whether to show availability.","uniqueKey":"showAvailability","typeLabel":"boolean"},"hideSold":{"type":"boolean","description":"Whether to hide sold units.","uniqueKey":"hideSold","typeLabel":"boolean"},"deliveryDates":{"type":"boolean","description":"Whether to show delivery dates.","uniqueKey":"deliveryDates","typeLabel":"boolean"},"internalURL":{"type":"string","format":"uri","description":"Internal URL for the group.","uniqueKey":"internalURL","typeLabel":"string\u003curi>"},"alternativeCovers":{"type":"array","items":{"type":"string","uniqueKey":"alternativeCovers.items.[INDEX]","typeLabel":"string"},"description":"List of alternative cover images.","uniqueKey":"alternativeCovers","typeLabel":"string[]"},"hideArea":{"type":"boolean","default":false,"description":"Whether to hide the area field.","uniqueKey":"hideArea","typeLabel":"boolean"},"theme":{"type":"string","description":"Theme of the group.","uniqueKey":"theme","typeLabel":"string"},"showBranding":{"type":"boolean","default":true,"description":"Whether to show branding.","uniqueKey":"showBranding","typeLabel":"boolean"},"showPriceFilter":{"type":"boolean","default":true,"description":"Whether to show the price filter.","uniqueKey":"showPriceFilter","typeLabel":"boolean"},"showAreaFilter":{"type":"boolean","default":true,"description":"Whether to show the area filter.","uniqueKey":"showAreaFilter","typeLabel":"boolean"},"showFloorOverview":{"type":"boolean","default":false,"description":"Whether to show the floor overview.","uniqueKey":"showFloorOverview","typeLabel":"boolean"},"colorBase":{"type":"string","description":"Base color.","uniqueKey":"colorBase","typeLabel":"string"},"colorAccent":{"type":"string","description":"Accent color.","uniqueKey":"colorAccent","typeLabel":"string"},"colorHover":{"type":"string","description":"Hover color.","uniqueKey":"colorHover","typeLabel":"string"},"colorButton":{"type":"string","description":"Button color.","uniqueKey":"colorButton","typeLabel":"string"},"colorButtonText":{"type":"string","description":"Button text color.","uniqueKey":"colorButtonText","typeLabel":"string"},"colorText":{"type":"string","description":"General text color.","uniqueKey":"colorText","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_id":"objectId","user":"objectId","name":"\u003cstring>","websiteURL":"\u003cstring>","showAvailableFirst":false,"projects":["objectId"],"namespace":"\u003cstring>","hostName":"\u003cstring>","groupLang":"en","linkBehavior":"Planpoint","accentColor":"\u003cstring>","groupImageUrl":"\u003cstring>","groupSVGUrl":"\u003cstring>","svgGroupId":"\u003cstring>","address":"\u003cstring>","lon":-93.75940812944687,"lat":43.75940812944687,"zoomLevel":0,"administrators":["objectId"],"editors":["objectId"],"invites":[{"firstName":"\u003cstring>","lastName":"\u003cstring>","email":"jsmith@example.com","level":"\u003cstring>"}],"perimeter":"\u003cstring>","markerImageUrl":"\u003cstring>","targetMarker":"\u003cstring>","mapStyle":"Light","mapPointColor":"\u003cstring>","showAllUnits":true,"showPrices":true,"initialView":"List","unitImageOnGrid":"Unit Plan","pricesStartingAt":false,"showTaxes":true,"priceBeforeTax":true,"showAvailability":true,"hideSold":true,"deliveryDates":true,"internalURL":"\u003cstring>","alternativeCovers":["\u003cstring>"],"hideArea":false,"theme":"\u003cstring>","showBranding":true,"showPriceFilter":true,"showAreaFilter":true,"showFloorOverview":false,"colorBase":"\u003cstring>","colorAccent":"\u003cstring>","colorHover":"\u003cstring>","colorButton":"\u003cstring>","colorButtonText":"\u003cstring>","colorText":"\u003cstring>"}}},"exampleType":"generated"},"application/xml":{"schema":{"type":"object","properties":{"_id":{"type":"string","format":"objectId","description":"The unique identifier for the group.","example":"objectId","uniqueKey":"_id","typeLabel":"string\u003cobjectId>"},"user":{"type":"string","format":"objectId","description":"Reference to the user who owns the group.","example":"objectId","uniqueKey":"user","typeLabel":"string\u003cobjectId>"},"name":{"type":"string","description":"Name of the group.","uniqueKey":"name","typeLabel":"string"},"websiteURL":{"type":"string","format":"uri","description":"URL of the group's website.","uniqueKey":"websiteURL","typeLabel":"string\u003curi>"},"showAvailableFirst":{"type":"boolean","default":false,"description":"Whether to prioritize showing available items first.","uniqueKey":"showAvailableFirst","typeLabel":"boolean"},"projects":{"type":"array","items":{"type":"string","format":"objectId","description":"ID of an associated project.","example":"objectId","uniqueKey":"projects.items.[INDEX]","typeLabel":"string\u003cobjectId>"},"uniqueKey":"projects","typeLabel":"string\u003cobjectId>[]"},"namespace":{"type":"string","description":"Namespace for the group.","uniqueKey":"namespace","typeLabel":"string"},"hostName":{"type":"string","description":"Hostname of the group.","uniqueKey":"hostName","typeLabel":"string"},"groupLang":{"type":"string","default":"en","description":"Language setting for the group.","uniqueKey":"groupLang","typeLabel":"string"},"linkBehavior":{"type":"string","default":"Planpoint","description":"Default link behavior.","uniqueKey":"linkBehavior","typeLabel":"string"},"accentColor":{"type":"string","description":"Accent color of the group.","uniqueKey":"accentColor","typeLabel":"string"},"groupImageUrl":{"type":"string","format":"uri","description":"URL of the group's image.","uniqueKey":"groupImageUrl","typeLabel":"string\u003curi>"},"groupSVGUrl":{"type":"string","format":"uri","description":"URL of the group's SVG.","uniqueKey":"groupSVGUrl","typeLabel":"string\u003curi>"},"svgGroupId":{"type":"string","description":"SVG group identifier.","uniqueKey":"svgGroupId","typeLabel":"string"},"address":{"type":"string","description":"Physical address of the group.","uniqueKey":"address","typeLabel":"string"},"lon":{"type":"number","format":"double","description":"Longitude of the group location.","example":-93.75940812944687,"uniqueKey":"lon","typeLabel":"number\u003cdouble>"},"lat":{"type":"number","format":"double","description":"Latitude of the group location.","example":43.75940812944687,"uniqueKey":"lat","typeLabel":"number\u003cdouble>"},"zoomLevel":{"type":"number","default":0,"description":"Default map zoom level.","uniqueKey":"zoomLevel","typeLabel":"number"},"administrators":{"type":"array","items":{"type":"string","format":"objectId","description":"ID of an administrator user.","example":"objectId","uniqueKey":"administrators.items.[INDEX]","typeLabel":"string\u003cobjectId>"},"uniqueKey":"administrators","typeLabel":"string\u003cobjectId>[]"},"editors":{"type":"array","items":{"type":"string","format":"objectId","description":"ID of an editor user.","example":"objectId","uniqueKey":"editors.items.[INDEX]","typeLabel":"string\u003cobjectId>"},"uniqueKey":"editors","typeLabel":"string\u003cobjectId>[]"},"invites":{"type":"array","items":{"type":"object","properties":{"firstName":{"type":"string","uniqueKey":"invites.items.[INDEX].firstName","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"invites.items.[INDEX].lastName","typeLabel":"string"},"email":{"type":"string","format":"email","uniqueKey":"invites.items.[INDEX].email","typeLabel":"string\u003cemail>"},"level":{"type":"string","uniqueKey":"invites.items.[INDEX].level","typeLabel":"string"}},"uniqueKey":"invites.items.[INDEX]","typeLabel":"object"},"description":"List of invited users.","uniqueKey":"invites","typeLabel":"object[]"},"perimeter":{"type":"string","description":"Perimeter of the group area.","uniqueKey":"perimeter","typeLabel":"string"},"markerImageUrl":{"type":"string","format":"uri","description":"URL of the marker image.","uniqueKey":"markerImageUrl","typeLabel":"string\u003curi>"},"targetMarker":{"type":"string","description":"Target marker identifier.","uniqueKey":"targetMarker","typeLabel":"string"},"mapStyle":{"type":"string","default":"Light","description":"Style of the map.","uniqueKey":"mapStyle","typeLabel":"string"},"mapPointColor":{"type":"string","description":"Color of map points.","uniqueKey":"mapPointColor","typeLabel":"string"},"showAllUnits":{"type":"boolean","description":"Whether to display all units.","uniqueKey":"showAllUnits","typeLabel":"boolean"},"showPrices":{"type":"boolean","description":"Whether to display prices.","uniqueKey":"showPrices","typeLabel":"boolean"},"initialView":{"type":"string","default":"List","description":"Initial view of the group.","uniqueKey":"initialView","typeLabel":"string"},"unitImageOnGrid":{"type":"string","default":"Unit Plan","description":"Image type shown on the grid.","uniqueKey":"unitImageOnGrid","typeLabel":"string"},"pricesStartingAt":{"type":"boolean","default":false,"description":"Whether to show prices starting at a certain value.","uniqueKey":"pricesStartingAt","typeLabel":"boolean"},"showTaxes":{"type":"boolean","description":"Whether to show taxes.","uniqueKey":"showTaxes","typeLabel":"boolean"},"priceBeforeTax":{"type":"boolean","description":"Whether the price is shown before tax.","uniqueKey":"priceBeforeTax","typeLabel":"boolean"},"showAvailability":{"type":"boolean","description":"Whether to show availability.","uniqueKey":"showAvailability","typeLabel":"boolean"},"hideSold":{"type":"boolean","description":"Whether to hide sold units.","uniqueKey":"hideSold","typeLabel":"boolean"},"deliveryDates":{"type":"boolean","description":"Whether to show delivery dates.","uniqueKey":"deliveryDates","typeLabel":"boolean"},"internalURL":{"type":"string","format":"uri","description":"Internal URL for the group.","uniqueKey":"internalURL","typeLabel":"string\u003curi>"},"alternativeCovers":{"type":"array","items":{"type":"string","uniqueKey":"alternativeCovers.items.[INDEX]","typeLabel":"string"},"description":"List of alternative cover images.","uniqueKey":"alternativeCovers","typeLabel":"string[]"},"hideArea":{"type":"boolean","default":false,"description":"Whether to hide the area field.","uniqueKey":"hideArea","typeLabel":"boolean"},"theme":{"type":"string","description":"Theme of the group.","uniqueKey":"theme","typeLabel":"string"},"showBranding":{"type":"boolean","default":true,"description":"Whether to show branding.","uniqueKey":"showBranding","typeLabel":"boolean"},"showPriceFilter":{"type":"boolean","default":true,"description":"Whether to show the price filter.","uniqueKey":"showPriceFilter","typeLabel":"boolean"},"showAreaFilter":{"type":"boolean","default":true,"description":"Whether to show the area filter.","uniqueKey":"showAreaFilter","typeLabel":"boolean"},"showFloorOverview":{"type":"boolean","default":false,"description":"Whether to show the floor overview.","uniqueKey":"showFloorOverview","typeLabel":"boolean"},"colorBase":{"type":"string","description":"Base color.","uniqueKey":"colorBase","typeLabel":"string"},"colorAccent":{"type":"string","description":"Accent color.","uniqueKey":"colorAccent","typeLabel":"string"},"colorHover":{"type":"string","description":"Hover color.","uniqueKey":"colorHover","typeLabel":"string"},"colorButton":{"type":"string","description":"Button color.","uniqueKey":"colorButton","typeLabel":"string"},"colorButtonText":{"type":"string","description":"Button text color.","uniqueKey":"colorButtonText","typeLabel":"string"},"colorText":{"type":"string","description":"General text color.","uniqueKey":"colorText","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_id":"objectId","user":"objectId","name":"\u003cstring>","websiteURL":"\u003cstring>","showAvailableFirst":false,"projects":["objectId"],"namespace":"\u003cstring>","hostName":"\u003cstring>","groupLang":"en","linkBehavior":"Planpoint","accentColor":"\u003cstring>","groupImageUrl":"\u003cstring>","groupSVGUrl":"\u003cstring>","svgGroupId":"\u003cstring>","address":"\u003cstring>","lon":-93.75940812944687,"lat":43.75940812944687,"zoomLevel":0,"administrators":["objectId"],"editors":["objectId"],"invites":[{"firstName":"\u003cstring>","lastName":"\u003cstring>","email":"jsmith@example.com","level":"\u003cstring>"}],"perimeter":"\u003cstring>","markerImageUrl":"\u003cstring>","targetMarker":"\u003cstring>","mapStyle":"Light","mapPointColor":"\u003cstring>","showAllUnits":true,"showPrices":true,"initialView":"List","unitImageOnGrid":"Unit Plan","pricesStartingAt":false,"showTaxes":true,"priceBeforeTax":true,"showAvailability":true,"hideSold":true,"deliveryDates":true,"internalURL":"\u003cstring>","alternativeCovers":["\u003cstring>"],"hideArea":false,"theme":"\u003cstring>","showBranding":true,"showPriceFilter":true,"showAreaFilter":true,"showFloorOverview":false,"colorBase":"\u003cstring>","colorAccent":"\u003cstring>","colorHover":"\u003cstring>","colorButton":"\u003cstring>","colorButtonText":"\u003cstring>","colorText":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"75708b89-c122-4e77-9706-5fe0783f2dcb":{"description":"Invalid input","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"e22ac421-51f4-431d-bcc1-10cead503d0f":{"AccessTokenAuth":{"type":"apiKey","in":"header","name":"Authorization","scopes":[]}}},"servers":{"7bb825c7-18c0-4f48-bb86-e5034be31eda":{"url":"https://app.planpoint.io/api"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","scopes":[]},"schema":{"title":"Authorization","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AccessTokenAuth","name":"Authorization"}],"title":"AccessTokenAuth"}]},"originalFileLocation":"api-documentation/openapi.json"},"subdomain":"planpoint","siteName":"Planpoint Viewer Docs","title":"Get Group - Planpoint Viewer Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-23T18:39:45.346Z","originalFileLocation":"api-documentation/endpoint/groups/id/get.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=\"Fetch a group\">\u003cmeta data-mint-head name=\"application-name\" content=\"Planpoint Viewer Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/planpoint/I4H3ZgKgth9zmV2U/_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/planpoint/I4H3ZgKgth9zmV2U/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/planpoint/I4H3ZgKgth9zmV2U/_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/planpoint/I4H3ZgKgth9zmV2U/_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/planpoint/I4H3ZgKgth9zmV2U/_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/planpoint/I4H3ZgKgth9zmV2U/_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/planpoint/I4H3ZgKgth9zmV2U/_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/planpoint/I4H3ZgKgth9zmV2U/_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/planpoint/I4H3ZgKgth9zmV2U/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Group - Planpoint Viewer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Fetch a group\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Planpoint Viewer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://viewerdocs.planpoint.io/api-documentation/endpoint/groups/id/get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://planpoint.mintlify.app/_mintlify/api/og/v2?division=Groups\u0026amp;title=Get+Group\u0026amp;description=Fetch+a+group\u0026amp;theme=0ba8030471b2f14b1bff3f40\u0026amp;signature=01ceac3b94a4ca6b6ff640f1ea62930b0f643fb2aea9cfe3904453e3bd6f72ec\">\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=\"Get Group - Planpoint Viewer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Fetch a group\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://planpoint.mintlify.app/_mintlify/api/og/v2?division=Groups\u0026amp;title=Get+Group\u0026amp;description=Fetch+a+group\u0026amp;theme=0ba8030471b2f14b1bff3f40\u0026amp;signature=01ceac3b94a4ca6b6ff640f1ea62930b0f643fb2aea9cfe3904453e3bd6f72ec\">\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/planpoint/I4H3ZgKgth9zmV2U/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Planpoint Viewer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0f68ea\">\u003clink data-mint-head rel=\"canonical\" href=\"https://viewerdocs.planpoint.io/api-documentation/endpoint/groups/id/get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-documentation/endpoint/groups/id/get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://viewerdocs.planpoint.io/#organization\",\"name\":\"Planpoint Viewer Docs\",\"url\":\"https://viewerdocs.planpoint.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/planpoint/ygbSuV-niiq46Suq/logo/light.svg?fit=max\u0026auto=format\u0026n=ygbSuV-niiq46Suq\u0026q=85\u0026s=7799fb568d5d530467492a989784f18f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://viewerdocs.planpoint.io#website\",\"name\":\"Planpoint Viewer Docs\",\"url\":\"https://viewerdocs.planpoint.io\",\"publisher\":{\"@id\":\"https://viewerdocs.planpoint.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://viewerdocs.planpoint.io/api-documentation/endpoint/groups/id/get#webpage\",\"url\":\"https://viewerdocs.planpoint.io/api-documentation/endpoint/groups/id/get\",\"name\":\"Get Group\",\"description\":\"Fetch a group\",\"dateModified\":\"2026-01-23T18:39:45.346Z\",\"isPartOf\":{\"@id\":\"https://viewerdocs.planpoint.io#website\"},\"breadcrumb\":{\"@id\":\"https://viewerdocs.planpoint.io/api-documentation/endpoint/groups/id/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://viewerdocs.planpoint.io/api-documentation/endpoint/groups/id/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Groups\",\"item\":\"https://viewerdocs.planpoint.io/api-documentation/endpoint/groups/get\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Group\",\"item\":\"https://viewerdocs.planpoint.io/api-documentation/endpoint/groups/id/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://viewerdocs.planpoint.io/api-documentation/endpoint/groups/id/get#apireference\",\"headline\":\"Get Group\",\"name\":\"Get Group\",\"description\":\"Fetch a group\",\"url\":\"https://viewerdocs.planpoint.io/api-documentation/endpoint/groups/id/get\",\"mainEntityOfPage\":{\"@id\":\"https://viewerdocs.planpoint.io/api-documentation/endpoint/groups/id/get#webpage\"},\"dateModified\":\"2026-01-23T18:39:45.346Z\",\"publisher\":{\"@id\":\"https://viewerdocs.planpoint.io/#organization\"},\"isPartOf\":{\"@id\":\"https://viewerdocs.planpoint.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Planpoint Viewer Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Planpoint Viewer Docs","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","tabs":[{"tab":"General","pages":[{"title":"General","href":"/welcome"}]},{"tab":"API ","groups":[{"group":"Introduction","pages":[{"title":"Introduction to Planpoint API","href":"/api-documentation/introduction"}]},{"group":"Authentication","pages":[{"title":"Login","openapi":"POST /users/login","href":"/api-documentation/endpoint/user/login"}]},{"group":"Groups","pages":[{"title":"Get Groups","openapi":"GET /groups","description":null,"href":"/api-documentation/endpoint/groups/get"},{"title":"Get Group","openapi":"GET /groups/{id}","href":"/api-documentation/endpoint/groups/id/get"},{"title":"Create Group","openapi":"POST /groups","description":"Create a new group","href":"/api-documentation/endpoint/groups/post"},{"title":"Update Group","openapi":"PATCH /groups/{id}","href":"/api-documentation/endpoint/groups/id/patch"}]},{"group":"Projects","pages":[{"title":"Get Projects","openapi":"GET /projects","href":"/api-documentation/endpoint/projects/get"},{"title":"Get Project","openapi":"GET /project/{id}","href":"/api-documentation/endpoint/projects/id/get"},{"title":"Create Project","openapi":"POST /projects","href":"/api-documentation/endpoint/projects/post"},{"title":"Update Project","openapi":"PATCH /project/{id}","href":"/api-documentation/endpoint/projects/id/patch"}]},{"group":"Floors","pages":[{"title":"Get Floors","openapi":"GET /floors","href":"/api-documentation/endpoint/floors/get"},{"title":"Get Floor","openapi":"GET /floors/{id}","href":"/api-documentation/endpoint/floors/id/get"},{"title":"Create Floor","openapi":"POST /floors","href":"/api-documentation/endpoint/floors/post"},{"title":"Update Floor","openapi":"PATCH /floor/{id}","href":"/api-documentation/endpoint/floors/id/patch"}]},{"group":"Units","pages":[{"title":"Get Units","openapi":"GET /units","href":"/api-documentation/endpoint/units/get"},{"title":"Get Unit","openapi":"GET /units/{id}","href":"/api-documentation/endpoint/units/id/get"},{"title":"Create Unit","openapi":"POST /units","href":"/api-documentation/endpoint/units/post"},{"title":"Update Unit","openapi":"PATCH /units/{id}","href":"/api-documentation/endpoint/units/id/patch"},{"title":"Delete Unit","openapi":"DELETE /units/{id}","href":"/api-documentation/endpoint/units/id/delete"}]},{"group":"Leads","pages":[{"title":"Get Leads","openapi":"GET /leads","href":"/api-documentation/endpoint/leads/get"}]}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/sdk-documentation/introduction"}]}]},{"anchor":"New releases","icon":"newspaper","href":"https://www.planpoint.io/new-releases/updates"},{"anchor":"Main website","icon":"globe","href":"https://www.planpoint.io/"},{"anchor":"Support","icon":"envelope-dot","href":"mailto:support@planpoint.io"}]},"title":"Get Group - Planpoint Viewer Docs","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}