{"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":""},"entitlements":{},"buildId":"6aeb4af4245c712a705ac282","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"Documentation","count":63},{"language":"default","tag":"General","count":36},{"language":"default","tag":"Advanced Features","count":21},{"language":"default","tag":"API ","count":21},{"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":"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":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-documentation/endpoint/user/login","slug":"/api-documentation/endpoint/user/login","pageMetadata":{"title":"Login","openapi":"POST /users/login","description":"","href":"/api-documentation/endpoint/user/login"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`step-by-step-guide-planpoint-login-api`,children:`Step-by-Step Guide: Planpoint Login API`}),`\n`,_jsxs(Heading,{level:`3`,id:`1-prepare-your-request-body`,children:[`1. `,_jsx(_components.strong,{children:`Prepare Your Request Body`})]}),`\n`,_jsx(_components.p,{children:`You’ll need to send a JSON payload with the following fields:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`username`}),`: Your email address (required, must be valid email format)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`password`}),`: Your password`]}),`\n`]}),`\n`,_jsxs(Heading,{level:`3`,id:`2-set-up-the-http-request`,children:[`2. `,_jsx(_components.strong,{children:`Set Up the HTTP Request`})]}),`\n`,_jsx(_components.p,{children:`Configure a POST request with:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Method`}),`: POST`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`URL`}),`: `,_jsx(_components.code,{children:`https://app.planpoint.io/api/users/login`})]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Content-Type`}),`: `,_jsx(_components.code,{children:`application/json`})]}),`\n`]}),`\n`,_jsxs(Heading,{level:`3`,id:`3-standard-login-flow`,children:[`3. `,_jsx(_components.strong,{children:`Standard Login Flow`})]}),`\n`,_jsx(_components.p,{children:`For regular user login, send this request body:`}),`\n`,_jsx(_components.p,{children:`json`}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`{ \"username\": \"your-email@example.com\", \"password\": \"your-password\" }`})}),`\n`,_jsx(_components.p,{children:`Example using cURL:`}),`\n`,_jsx(_components.p,{children:`bash`}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`curl --request POST \\\\ --url https://app.planpoint.io/api/users/login \\\\ --header 'Content-Type: application/json' \\\\ --data '{ \"username\": \"your-email@example.com\", \"password\": \"your-password\" }'`})}),`\n`,_jsxs(Heading,{level:`3`,id:`4-handle-the-response`,children:[`4. `,_jsx(_components.strong,{children:`Handle the Response`})]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Success Response (200):`})}),`\n`,_jsx(_components.p,{children:`json`}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`{ \"message\": \"Login successful\", \"access_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\" }`})}),`\n`,_jsx(_components.p,{children:`The response includes:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`access_token`}),`: JWT token for authenticating future API requests`]}),`\n`,_jsxs(_components.li,{children:[`HTTP-only cookies are automatically set in your browser:`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`planpoint`}),`: Access token (expires in 1 day for regular users, 90 days for Zapier)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`planpointRefresh`}),`: Refresh token (expires in 7 days, not set for Zapier users)`]}),`\n`]}),`\n`]}),`\n`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Error Responses:`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`400`}),`: Invalid request body (username not an email, etc.)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`401`}),`: User not found, incorrect credentials, or unauthorized`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`403`}),`: Not allowed (for impersonation attempts)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`405`}),`: Method not allowed (if not using POST)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`500`}),`: Server error`]}),`\n`]}),`\n`,_jsxs(Heading,{level:`3`,id:`5-use-the-access-token`,children:[`5. `,_jsx(_components.strong,{children:`Use the Access Token`})]}),`\n`,_jsxs(_components.p,{children:[`For subsequent API requests, use the `,_jsx(_components.code,{children:`access_token`}),` from the response in your Authorization header:`]}),`\n`,_jsx(_components.p,{children:`bash`}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`Authorization: Bearer YOUR_ACCESS_TOKEN`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Login","openapi":"POST /users/login","description":"","href":"/api-documentation/endpoint/user/login"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Step-by-Step Guide: Planpoint Login API","slug":"step-by-step-guide-planpoint-login-api","depth":2,"children":[{"title":"1. Prepare Your Request Body","slug":"1-prepare-your-request-body","depth":3,"children":[]},{"title":"2. Set Up the HTTP Request","slug":"2-set-up-the-http-request","depth":3,"children":[]},{"title":"3. Standard Login Flow","slug":"3-standard-login-flow","depth":3,"children":[]},{"title":"4. Handle the Response","slug":"4-handle-the-response","depth":3,"children":[]},{"title":"5. Use the Access Token","slug":"5-use-the-access-token","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["user"],"summary":"Logs user into the system","description":"","operationId":"loginUser","parameters":["afa9e7d0-e142-4aa9-8a15-9269e4edee1f","d93fd351-8878-4005-ac66-b6674a2f73bc"],"responses":{"200":"f6a77885-51bb-40d6-b688-13b1941bc82a","400":"f3b393dc-b6fc-4549-884e-37d43e7b0112"},"method":"post","type":"path","servers":["7bb825c7-18c0-4f48-bb86-e5034be31eda"],"security":["e22ac421-51f4-431d-bcc1-10cead503d0f"],"path":"/users/login","baseUrlOptions":["https://app.planpoint.io/api"],"title":"Logs user into the system","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"afa9e7d0-e142-4aa9-8a15-9269e4edee1f":{"name":"username","in":"query","description":"The user name for login","required":true,"schema":{"type":"string","isRequired":true,"description":"The user name for login","uniqueKey":"","typeLabel":"string"}},"d93fd351-8878-4005-ac66-b6674a2f73bc":{"name":"password","in":"query","description":"The password for login","required":true,"schema":{"type":"string","isRequired":true,"description":"The password for login","uniqueKey":"","typeLabel":"string"}}},"responses":{"f6a77885-51bb-40d6-b688-13b1941bc82a":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"_id":{"type":"string","format":"objectId","description":"Unique identifier for the user","uniqueKey":"_id","typeLabel":"string\u003cobjectId>"},"role":{"type":"string","format":"objectId","description":"Reference to the user's role","uniqueKey":"role","typeLabel":"string\u003cobjectId>"},"username":{"type":"string","description":"Unique username of the user","uniqueKey":"username","typeLabel":"string"},"name":{"type":"string","description":"First name of the user","uniqueKey":"name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the user","uniqueKey":"lastName","typeLabel":"string"},"fullName":{"type":"string","description":"Full name of the user","uniqueKey":"fullName","typeLabel":"string"},"phone":{"type":"string","description":"Phone number of the user","uniqueKey":"phone","typeLabel":"string"},"companyName":{"type":"string","description":"Name of the user's company","uniqueKey":"companyName","typeLabel":"string"},"projectNameURL":{"type":"string","description":"URL for the user's project name","uniqueKey":"projectNameURL","typeLabel":"string"},"country":{"type":"string","description":"Country of the user","uniqueKey":"country","typeLabel":"string"},"address1":{"type":"string","description":"Primary address of the user","uniqueKey":"address1","typeLabel":"string"},"address2":{"type":"string","description":"Secondary address of the user","uniqueKey":"address2","typeLabel":"string"},"city":{"type":"string","description":"City of the user","uniqueKey":"city","typeLabel":"string"},"region":{"type":"string","description":"Region or state of the user","uniqueKey":"region","typeLabel":"string"},"zip":{"type":"string","description":"ZIP code of the user","uniqueKey":"zip","typeLabel":"string"},"token":{"type":"string","description":"Authentication token for the user","uniqueKey":"token","typeLabel":"string"},"stripeAccountId":{"type":"string","description":"Stripe account ID of the user","uniqueKey":"stripeAccountId","typeLabel":"string"},"stripeOnboardingDone":{"type":"boolean","default":false,"description":"Indicates if Stripe onboarding is complete","uniqueKey":"stripeOnboardingDone","typeLabel":"boolean"},"stripeDetailsSubmitted":{"type":"boolean","default":false,"description":"Indicates if Stripe details have been submitted","uniqueKey":"stripeDetailsSubmitted","typeLabel":"boolean"},"experimentalFeatures":{"type":"boolean","default":false,"description":"Indicates if experimental features are enabled","uniqueKey":"experimentalFeatures","typeLabel":"boolean"},"resetToken":{"type":"string","description":"Token for resetting the user's password","uniqueKey":"resetToken","typeLabel":"string"},"stripeCustomer":{"type":"object","description":"Stripe customer information for the user","uniqueKey":"stripeCustomer","typeLabel":"object"},"subscription":{"type":"object","description":"Subscription details for the user","uniqueKey":"subscription","typeLabel":"object"},"appliedTrial":{"type":"boolean","default":false,"description":"Indicates if the user has applied a trial","uniqueKey":"appliedTrial","typeLabel":"boolean"},"projects":{"type":"array","items":{"type":"string","format":"objectId","uniqueKey":"projects.items.[INDEX]","typeLabel":"string\u003cobjectId>"},"description":"List of projects associated with the user","uniqueKey":"projects","typeLabel":"string\u003cobjectId>[]"},"groups":{"type":"array","items":{"type":"string","format":"objectId","uniqueKey":"groups.items.[INDEX]","typeLabel":"string\u003cobjectId>"},"description":"List of groups associated with the user","uniqueKey":"groups","typeLabel":"string\u003cobjectId>[]"},"administrators":{"type":"array","items":{"type":"string","format":"objectId","uniqueKey":"administrators.items.[INDEX]","typeLabel":"string\u003cobjectId>"},"description":"List of administrators associated with the user","uniqueKey":"administrators","typeLabel":"string\u003cobjectId>[]"},"editors":{"type":"array","items":{"type":"string","format":"objectId","uniqueKey":"editors.items.[INDEX]","typeLabel":"string\u003cobjectId>"},"description":"List of editors associated with the user","uniqueKey":"editors","typeLabel":"string\u003cobjectId>[]"},"invites":{"type":"array","items":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the invitee","uniqueKey":"invites.items.[INDEX].firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the invitee","uniqueKey":"invites.items.[INDEX].lastName","typeLabel":"string"},"email":{"type":"string","format":"email","description":"Email address of the invitee","uniqueKey":"invites.items.[INDEX].email","typeLabel":"string\u003cemail>"},"level":{"type":"string","description":"Access level for the invitee","uniqueKey":"invites.items.[INDEX].level","typeLabel":"string"}},"uniqueKey":"invites.items.[INDEX]","typeLabel":"object"},"description":"List of invites associated with the user","uniqueKey":"invites","typeLabel":"object[]"},"preferences":{"type":"object","properties":{"hideBrandingIcon":{"type":"boolean","default":false,"description":"Indicates if the branding icon is hidden in the viewer","uniqueKey":"preferences.hideBrandingIcon","typeLabel":"boolean"},"hideLoadingLogo":{"type":"boolean","default":false,"description":"Indicates if the loading logo is hidden in the viewer","uniqueKey":"preferences.hideLoadingLogo","typeLabel":"boolean"}},"description":"User preferences","uniqueKey":"preferences","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_id":"\u003cstring>","role":"\u003cstring>","username":"\u003cstring>","name":"\u003cstring>","lastName":"\u003cstring>","fullName":"\u003cstring>","phone":"\u003cstring>","companyName":"\u003cstring>","projectNameURL":"\u003cstring>","country":"\u003cstring>","address1":"\u003cstring>","address2":"\u003cstring>","city":"\u003cstring>","region":"\u003cstring>","zip":"\u003cstring>","token":"\u003cstring>","stripeAccountId":"\u003cstring>","stripeOnboardingDone":false,"stripeDetailsSubmitted":false,"experimentalFeatures":false,"resetToken":"\u003cstring>","stripeCustomer":{},"subscription":{},"appliedTrial":false,"projects":["\u003cstring>"],"groups":["\u003cstring>"],"administrators":["\u003cstring>"],"editors":["\u003cstring>"],"invites":[{"firstName":"\u003cstring>","lastName":"\u003cstring>","email":"jsmith@example.com","level":"\u003cstring>"}],"preferences":{"hideBrandingIcon":false,"hideLoadingLogo":false}}}},"exampleType":"generated"},"application/xml":{"schema":{"type":"object","properties":{"_id":{"type":"string","format":"objectId","description":"Unique identifier for the user","uniqueKey":"_id","typeLabel":"string\u003cobjectId>"},"role":{"type":"string","format":"objectId","description":"Reference to the user's role","uniqueKey":"role","typeLabel":"string\u003cobjectId>"},"username":{"type":"string","description":"Unique username of the user","uniqueKey":"username","typeLabel":"string"},"name":{"type":"string","description":"First name of the user","uniqueKey":"name","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the user","uniqueKey":"lastName","typeLabel":"string"},"fullName":{"type":"string","description":"Full name of the user","uniqueKey":"fullName","typeLabel":"string"},"phone":{"type":"string","description":"Phone number of the user","uniqueKey":"phone","typeLabel":"string"},"companyName":{"type":"string","description":"Name of the user's company","uniqueKey":"companyName","typeLabel":"string"},"projectNameURL":{"type":"string","description":"URL for the user's project name","uniqueKey":"projectNameURL","typeLabel":"string"},"country":{"type":"string","description":"Country of the user","uniqueKey":"country","typeLabel":"string"},"address1":{"type":"string","description":"Primary address of the user","uniqueKey":"address1","typeLabel":"string"},"address2":{"type":"string","description":"Secondary address of the user","uniqueKey":"address2","typeLabel":"string"},"city":{"type":"string","description":"City of the user","uniqueKey":"city","typeLabel":"string"},"region":{"type":"string","description":"Region or state of the user","uniqueKey":"region","typeLabel":"string"},"zip":{"type":"string","description":"ZIP code of the user","uniqueKey":"zip","typeLabel":"string"},"token":{"type":"string","description":"Authentication token for the user","uniqueKey":"token","typeLabel":"string"},"stripeAccountId":{"type":"string","description":"Stripe account ID of the user","uniqueKey":"stripeAccountId","typeLabel":"string"},"stripeOnboardingDone":{"type":"boolean","default":false,"description":"Indicates if Stripe onboarding is complete","uniqueKey":"stripeOnboardingDone","typeLabel":"boolean"},"stripeDetailsSubmitted":{"type":"boolean","default":false,"description":"Indicates if Stripe details have been submitted","uniqueKey":"stripeDetailsSubmitted","typeLabel":"boolean"},"experimentalFeatures":{"type":"boolean","default":false,"description":"Indicates if experimental features are enabled","uniqueKey":"experimentalFeatures","typeLabel":"boolean"},"resetToken":{"type":"string","description":"Token for resetting the user's password","uniqueKey":"resetToken","typeLabel":"string"},"stripeCustomer":{"type":"object","description":"Stripe customer information for the user","uniqueKey":"stripeCustomer","typeLabel":"object"},"subscription":{"type":"object","description":"Subscription details for the user","uniqueKey":"subscription","typeLabel":"object"},"appliedTrial":{"type":"boolean","default":false,"description":"Indicates if the user has applied a trial","uniqueKey":"appliedTrial","typeLabel":"boolean"},"projects":{"type":"array","items":{"type":"string","format":"objectId","uniqueKey":"projects.items.[INDEX]","typeLabel":"string\u003cobjectId>"},"description":"List of projects associated with the user","uniqueKey":"projects","typeLabel":"string\u003cobjectId>[]"},"groups":{"type":"array","items":{"type":"string","format":"objectId","uniqueKey":"groups.items.[INDEX]","typeLabel":"string\u003cobjectId>"},"description":"List of groups associated with the user","uniqueKey":"groups","typeLabel":"string\u003cobjectId>[]"},"administrators":{"type":"array","items":{"type":"string","format":"objectId","uniqueKey":"administrators.items.[INDEX]","typeLabel":"string\u003cobjectId>"},"description":"List of administrators associated with the user","uniqueKey":"administrators","typeLabel":"string\u003cobjectId>[]"},"editors":{"type":"array","items":{"type":"string","format":"objectId","uniqueKey":"editors.items.[INDEX]","typeLabel":"string\u003cobjectId>"},"description":"List of editors associated with the user","uniqueKey":"editors","typeLabel":"string\u003cobjectId>[]"},"invites":{"type":"array","items":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the invitee","uniqueKey":"invites.items.[INDEX].firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Last name of the invitee","uniqueKey":"invites.items.[INDEX].lastName","typeLabel":"string"},"email":{"type":"string","format":"email","description":"Email address of the invitee","uniqueKey":"invites.items.[INDEX].email","typeLabel":"string\u003cemail>"},"level":{"type":"string","description":"Access level for the invitee","uniqueKey":"invites.items.[INDEX].level","typeLabel":"string"}},"uniqueKey":"invites.items.[INDEX]","typeLabel":"object"},"description":"List of invites associated with the user","uniqueKey":"invites","typeLabel":"object[]"},"preferences":{"type":"object","properties":{"hideBrandingIcon":{"type":"boolean","default":false,"description":"Indicates if the branding icon is hidden in the viewer","uniqueKey":"preferences.hideBrandingIcon","typeLabel":"boolean"},"hideLoadingLogo":{"type":"boolean","default":false,"description":"Indicates if the loading logo is hidden in the viewer","uniqueKey":"preferences.hideLoadingLogo","typeLabel":"boolean"}},"description":"User preferences","uniqueKey":"preferences","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_id":"\u003cstring>","role":"\u003cstring>","username":"\u003cstring>","name":"\u003cstring>","lastName":"\u003cstring>","fullName":"\u003cstring>","phone":"\u003cstring>","companyName":"\u003cstring>","projectNameURL":"\u003cstring>","country":"\u003cstring>","address1":"\u003cstring>","address2":"\u003cstring>","city":"\u003cstring>","region":"\u003cstring>","zip":"\u003cstring>","token":"\u003cstring>","stripeAccountId":"\u003cstring>","stripeOnboardingDone":false,"stripeDetailsSubmitted":false,"experimentalFeatures":false,"resetToken":"\u003cstring>","stripeCustomer":{},"subscription":{},"appliedTrial":false,"projects":["\u003cstring>"],"groups":["\u003cstring>"],"administrators":["\u003cstring>"],"editors":["\u003cstring>"],"invites":[{"firstName":"\u003cstring>","lastName":"\u003cstring>","email":"jsmith@example.com","level":"\u003cstring>"}],"preferences":{"hideBrandingIcon":false,"hideLoadingLogo":false}}}},"exampleType":"generated"}},"exampleType":"generated"},"f3b393dc-b6fc-4549-884e-37d43e7b0112":{"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":"Login - Planpoint Viewer Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-03T19:07:21.449Z","originalFileLocation":"api-documentation/endpoint/user/login.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"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=\"Login - Planpoint Viewer Docs\">\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/user/login\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://planpoint.mintlify.site/_mintlify/api/og/v2?division=Authentication\u0026amp;title=Login\u0026amp;theme=0ba8030471b2f14b1bff3f40\u0026amp;signature=30189aab550b5e908ab1792c9938b7d5862393cb8f3b49e7390ea622c0992075\">\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=\"Login - Planpoint Viewer Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://planpoint.mintlify.site/_mintlify/api/og/v2?division=Authentication\u0026amp;title=Login\u0026amp;theme=0ba8030471b2f14b1bff3f40\u0026amp;signature=30189aab550b5e908ab1792c9938b7d5862393cb8f3b49e7390ea622c0992075\">\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/user/login\">\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/user/login.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/user/login#webpage\",\"url\":\"https://viewerdocs.planpoint.io/api-documentation/endpoint/user/login\",\"name\":\"Login\",\"dateModified\":\"2026-02-03T19:07:21.449Z\",\"isPartOf\":{\"@id\":\"https://viewerdocs.planpoint.io#website\"},\"breadcrumb\":{\"@id\":\"https://viewerdocs.planpoint.io/api-documentation/endpoint/user/login#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://viewerdocs.planpoint.io/api-documentation/endpoint/user/login#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Planpoint Viewer Docs\",\"item\":\"https://viewerdocs.planpoint.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Login\",\"item\":\"https://viewerdocs.planpoint.io/api-documentation/endpoint/user/login\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://viewerdocs.planpoint.io/api-documentation/endpoint/user/login#apireference\",\"headline\":\"Login\",\"name\":\"Login\",\"url\":\"https://viewerdocs.planpoint.io/api-documentation/endpoint/user/login\",\"mainEntityOfPage\":{\"@id\":\"https://viewerdocs.planpoint.io/api-documentation/endpoint/user/login#webpage\"},\"dateModified\":\"2026-02-03T19:07:21.449Z\",\"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","description":"In this section, we will be exploring our public RESTful 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","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"}]},{"group":"Webhooks","pages":[{"title":"Webhooks","href":"/api-documentation/webhooks"}]}]},{"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"}]},"basePath":"","title":"Login - Planpoint Viewer Docs","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}