A system user representing an employee or team member. Inherits common entity fields and includes personal information, contact details, contract information, and system access settings.
Analytics and performance tracking information for users
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Pland Developer Platform","colors":{"primary":"#2563EB","light":"#bfdbfe","dark":"#1E40AF"},"logo":{"light":"https://mintcdn.com/pland/4nF818XuJvdH1X-y/logo/logo-light.png?fit=max\u0026auto=format\u0026n=4nF818XuJvdH1X-y\u0026q=85\u0026s=58e21d630b18eebde27bee10fa752eb3","dark":"https://mintcdn.com/pland/4nF818XuJvdH1X-y/logo/logo-dark.png?fit=max\u0026auto=format\u0026n=4nF818XuJvdH1X-y\u0026q=85\u0026s=426b8f2e17759f6cab27a2049c396092"},"favicon":"https://mintcdn.com/pland/4nF818XuJvdH1X-y/favicon.png?fit=max\u0026auto=format\u0026n=4nF818XuJvdH1X-y\u0026q=85\u0026s=118b9198f497329520268b5f9511ff95","navbar":{"links":[{"href":"mailto:support@pland.app","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://cloud.pland.app/login"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/pland-software","youtube":"https://www.youtube.com/@pland.software"}},"seo":{"indexing":"navigable"},"icons":{"library":"fontawesome"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Roadmap","icon":"road","href":"https://feedback.pland.app/de/roadmap/main"},{"anchor":"Changelog","icon":"bullhorn","href":"https://feedback.pland.app/de/changelog"},{"anchor":"Knowledge Base","icon":"book","href":"https://help.pland.app"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pland","hasAudioNarration":false,"actualSubdomain":"pland","customDomains":["docs.pland.app"],"gitSource":{"type":"gitlab","owner":"common-digital","repo":"pland-docs","projectId":71427967,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e72d094e7057e3148df0","collectionId":"72c63d0c-dc7f-4b3f-8b62-95a30f93a70b","schemaVersion":"v2"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aee03c755bb8cace6bce8ab","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":79},{"language":"default","tag":"Documents","count":8},{"language":"default","tag":"Users","count":8},{"language":"default","tag":"Tasks","count":7},{"language":"default","tag":"Customers","count":6},{"language":"default","tag":"Objects","count":6},{"language":"default","tag":"Absences","count":5},{"language":"default","tag":"Articles","count":5},{"language":"default","tag":"Equipment","count":5},{"language":"default","tag":"Quality Control","count":5}]},"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":"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":[{"filePath":"stylse.css","content":".nav-tabs-item:nth-child(3)::after{content:\"Coming soon\";display:inline-block;font-size:.65rem;font-weight:700;line-height:1.25;padding:.125rem .25rem;margin-left:.5rem;border-radius:var(--rounded-md, .375rem);background-color:rgb(var(--primary) / .1)}html.light .nav-tabs-item:nth-child(3)::after{color:rgb(var(--primary-dark))}html.dark .nav-tabs-item:nth-child(3)::after{color:rgb(var(--primary-light))}"}],"page":{"pagePath":"api-reference/users/get","slug":"/api-reference/users/get","pageMetadata":{"title":"Get User","openapi":"GET /users/{id}","description":"Retrieves a user by their ID. Use \"self\" as ID to get the authenticated user's own information.","href":"/api-reference/users/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: \"Retrieves a user by their ID. Use “self” as ID to get the authenticated user’s own information.\"\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 User","openapi":"GET /users/{id}","description":"Retrieves a user by their ID. Use \"self\" as ID to get the authenticated user's own information.","href":"/api-reference/users/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Users"],"summary":"Get user by ID","description":"Retrieves a user by their ID. Use \"self\" as ID to get the authenticated user's own information.","operationId":"getUserById","parameters":["a898a94a-c595-437c-84be-65e7bb455611"],"responses":{"200":"5297e6a0-9a29-49e8-8f8c-c7d7bcb0bf83","401":"0804b0df-f4fa-4ac4-a110-566ec6b22dc4","403":"038da2f4-567d-43da-8ba1-18791dab8491","404":"cb91d71f-0178-4cc7-a7fd-91d43a082898","500":"9b1d9a37-8595-4641-a214-da2139534a02"},"security":["7f117203-2981-4138-a052-58b724ec5773","e4f4e05f-c6e7-4d0d-8d4b-d830fb1b8a27"],"method":"get","type":"path","servers":["049f04bf-2709-4eaa-8561-4ab663e714af","c9c1a3f9-30ec-4c06-b6dc-9dac055b68a8"],"path":"/users/{id}","baseUrlOptions":["https://cloud-api.pland.app/v2","https://beta-api.pland.app/v2"],"title":"Get user by ID","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a898a94a-c595-437c-84be-65e7bb455611":{"name":"id","in":"path","description":"User ID or \"self\" for authenticated user","required":true,"schema":{"type":"string","format":"objectid","isRequired":true,"description":"User ID or \"self\" for authenticated user","uniqueKey":"","typeLabel":"string\u003cobjectid>"}}},"responses":{"5297e6a0-9a29-49e8-8f8c-c7d7bcb0bf83":{"description":"User retrieved successfully","content":{"application/json":{"schema":{"type":"object","title":"User","description":"A system user representing an employee or team member. Inherits common entity fields and includes personal information, contact details, contract information, and system access settings.","properties":{"_id":{"description":"Unique identifier of the entity","type":"string","format":"objectid","uniqueKey":"_id","typeLabel":"string\u003cobjectid>"},"number":{"description":"Unique number of the entity, used for identification","type":"integer","uniqueKey":"number","typeLabel":"integer"},"companyId":{"description":"The ID of the company this entity belongs to","type":"string","format":"objectid","x-internal":true,"uniqueKey":"companyId","typeLabel":"string\u003cobjectid>"},"status":{"description":"Entity Status information","properties":{"status":{"description":"Current status","type":"integer","uniqueKey":"status.status","typeLabel":"integer"},"createdAt":{"description":"Creation timestamp","type":"string","format":"date-time","uniqueKey":"status.createdAt","typeLabel":"string\u003cdate-time>"},"createdBy":{"description":"User who created this supplier","type":"string","format":"objectid","uniqueKey":"status.createdBy","typeLabel":"string\u003cobjectid>"},"lastModifiedAt":{"description":"Last modification timestamp","type":"string","format":"date-time","uniqueKey":"status.lastModifiedAt","typeLabel":"string\u003cdate-time>"},"lastModifiedBy":{"description":"User who last modified this supplier","type":"string","format":"objectid","uniqueKey":"status.lastModifiedBy","typeLabel":"string\u003cobjectid>"},"agentId":{"oneOf":[{"description":"Agent that created or modified this entity","type":"string","format":"objectid","uniqueKey":"status.agentId.oneOf.0","typeLabel":"string\u003cobjectid>"},{"description":"Agent that created or modified this entity","type":"null","format":"objectid","uniqueKey":"status.agentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"status.agentId","typeLabel":"string\u003cobjectid> | null"},"assistantId":{"oneOf":[{"description":"Text assistant that created or modified this entity on behalf of a user","type":"string","format":"objectid","uniqueKey":"status.assistantId.oneOf.0","typeLabel":"string\u003cobjectid>"},{"description":"Text assistant that created or modified this entity on behalf of a user","type":"null","format":"objectid","uniqueKey":"status.assistantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"status.assistantId","typeLabel":"string\u003cobjectid> | null"}},"type":"object","uniqueKey":"status","typeLabel":"object"},"chatId":{"oneOf":[{"description":"ID of the chat associated with this entity","type":"string","format":"objectid","uniqueKey":"chatId.oneOf.0","typeLabel":"string\u003cobjectid>"},{"description":"ID of the chat associated with this entity","type":"null","format":"objectid","uniqueKey":"chatId.oneOf.1","typeLabel":"null"}],"uniqueKey":"chatId","typeLabel":"string\u003cobjectid> | null"},"id":{"description":"Login ID","type":"number","format":"int32","example":"36920","uniqueKey":"id","typeLabel":"number\u003cint32>"},"general":{"title":"User General Information","description":"General personal information and profile data for a user","properties":{"firstName":{"description":"First name of the user","type":"string","example":"John","uniqueKey":"general.firstName","typeLabel":"string"},"lastName":{"description":"Last name of the user","type":"string","example":"Doe","uniqueKey":"general.lastName","typeLabel":"string"},"sex":{"description":"Gender/sex of the user","type":"string","enum":["male","female","divers"],"example":"male","uniqueKey":"general.sex","typeLabel":"enum\u003cstring>"},"birthDate":{"description":"The birthday of the user dd.mm.yyyy format","type":"string","pattern":"^\\d{2}\\.\\d{2}\\.\\d{4}$","example":"15.08.1990","uniqueKey":"general.birthDate","typeLabel":"string"},"language":{"description":"Preferred language code for the user interface","type":"string","example":"de","uniqueKey":"general.language","typeLabel":"string"},"deviceToken":{"description":"Mobile device push notification token","type":"string","example":"dGhpcyBpcyBhIHRva2VuIGV4YW1wbGU=","uniqueKey":"general.deviceToken","typeLabel":"string"},"webPushToken":{"oneOf":[{"description":"Web browser push notification token","type":"string","example":"BKP4z...","uniqueKey":"general.webPushToken.oneOf.0","typeLabel":"string"},{"description":"Web browser push notification token","type":"null","example":"BKP4z...","uniqueKey":"general.webPushToken.oneOf.1","typeLabel":"null"}],"uniqueKey":"general.webPushToken","typeLabel":"string | null"},"profileImage":{"oneOf":[{"description":"URL or identifier for user profile image","type":"string","example":"https://example.com/profiles/user123.jpg","uniqueKey":"general.profileImage.oneOf.0","typeLabel":"string"},{"description":"URL or identifier for user profile image","type":"null","example":"https://example.com/profiles/user123.jpg","uniqueKey":"general.profileImage.oneOf.1","typeLabel":"null"}],"uniqueKey":"general.profileImage","typeLabel":"string | null"},"description":{"oneOf":[{"description":"Free text description or notes about the user","type":"string","example":"Team lead with 5 years experience","uniqueKey":"general.description.oneOf.0","typeLabel":"string"},{"description":"Free text description or notes about the user","type":"null","example":"Team lead with 5 years experience","uniqueKey":"general.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"general.description","typeLabel":"string | null"},"lastNpsScoreSend":{"oneOf":[{"description":"Last time NPS score survey was sent to user","type":"string","format":"date-time","uniqueKey":"general.lastNpsScoreSend.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Last time NPS score survey was sent to user","type":"null","format":"date-time","uniqueKey":"general.lastNpsScoreSend.oneOf.1","typeLabel":"null"}],"uniqueKey":"general.lastNpsScoreSend","typeLabel":"string\u003cdate-time> | null"},"badges":{"oneOf":[{"description":"Achievement badges earned by the user","type":"array","items":{"type":"object","uniqueKey":"general.badges.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[{"type":"experience","level":"senior"}],"uniqueKey":"general.badges.oneOf.0","typeLabel":"object[]"},{"description":"Achievement badges earned by the user","type":"null","items":{"type":"object"},"example":[{"type":"experience","level":"senior"}],"uniqueKey":"general.badges.oneOf.1","typeLabel":"null"}],"uniqueKey":"general.badges","typeLabel":"object[] | null"},"myTutorialUsername":{"oneOf":[{"description":"Username for the MyTutorial platform","type":"string","example":"mytutorial_user123","uniqueKey":"general.myTutorialUsername.oneOf.0","typeLabel":"string"},{"description":"Username for the MyTutorial platform","type":"null","example":"mytutorial_user123","uniqueKey":"general.myTutorialUsername.oneOf.1","typeLabel":"null"}],"uniqueKey":"general.myTutorialUsername","typeLabel":"string | null"}},"type":"object","uniqueKey":"general","typeLabel":"User General Information · object"},"access":{"title":"User Access Credentials","description":"User authentication and access control information including login credentials, permissions, and security settings","properties":{"dashboardAccess":{"description":"Whether the user has access to dashboard features","type":"boolean","example":true,"uniqueKey":"access.dashboardAccess","typeLabel":"boolean"},"webAccess":{"description":"Web access permission level or status","type":"string","example":"1","uniqueKey":"access.webAccess","typeLabel":"string"},"token":{"description":"Authentication token for API access (security-sensitive)","type":"string","format":"uuid","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","uniqueKey":"access.token","typeLabel":"string\u003cuuid>"},"email":{"description":"User email address used for login and communication","type":"string","format":"email","example":"user@company.com","uniqueKey":"access.email","typeLabel":"string\u003cemail>"},"loginTries":{"description":"Number of failed login attempts (used for account security)","type":"integer","minimum":0,"example":0,"uniqueKey":"access.loginTries","typeLabel":"integer"},"passwordChangeToken":{"oneOf":[{"description":"Token used for password reset functionality","type":"string","example":"reset-token-12345","uniqueKey":"access.passwordChangeToken.oneOf.0","typeLabel":"string"},{"description":"Token used for password reset functionality","type":"null","example":"reset-token-12345","uniqueKey":"access.passwordChangeToken.oneOf.1","typeLabel":"null"}],"uniqueKey":"access.passwordChangeToken","typeLabel":"string | null"},"passwordChangeDate":{"oneOf":[{"description":"Date when password was last changed","type":"string","format":"date-time","example":"2023-12-01T10:30:00.000Z","uniqueKey":"access.passwordChangeDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Date when password was last changed","type":"null","format":"date-time","example":"2023-12-01T10:30:00.000Z","uniqueKey":"access.passwordChangeDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"access.passwordChangeDate","typeLabel":"string\u003cdate-time> | null"}},"type":"object","uniqueKey":"access","typeLabel":"User Access Credentials · object"},"contract":{"type":"object","title":"Employment Contract","description":"Employment contract information including dates, salary, working hours, and employment terms","properties":{"startDate":{"oneOf":[{"description":"Contract start date","type":"string","format":"date-time","uniqueKey":"contract.startDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Contract start date","type":"null","format":"date-time","uniqueKey":"contract.startDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"contract.startDate","typeLabel":"string\u003cdate-time> | null"},"endDate":{"oneOf":[{"description":"Contract end date. Empty means open-ended.","type":"string","format":"date-time","uniqueKey":"contract.endDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Contract end date. Empty means open-ended.","type":"null","format":"date-time","uniqueKey":"contract.endDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"contract.endDate","typeLabel":"string\u003cdate-time> | null"},"department":{"description":"Department assignment (deprecated, use accessGroupId instead)","type":"string","example":"service","deprecated":true,"uniqueKey":"contract.department","typeLabel":"string"},"salary":{"description":"Salary amount (hourly rate or monthly salary depending on salary type)","type":"number","format":"float","example":15.5,"uniqueKey":"contract.salary","typeLabel":"number\u003cfloat>"},"annualLeaveEntitlement":{"oneOf":[{"description":"Leave days per year of the contract version valid today (written by UserContractVersion::writeToContract)","type":"number","format":"float","example":30,"uniqueKey":"contract.annualLeaveEntitlement.oneOf.0","typeLabel":"number\u003cfloat>"},{"description":"Leave days per year of the contract version valid today (written by UserContractVersion::writeToContract)","type":"null","format":"float","example":30,"uniqueKey":"contract.annualLeaveEntitlement.oneOf.1","typeLabel":"null"}],"uniqueKey":"contract.annualLeaveEntitlement","typeLabel":"number\u003cfloat> | null"},"leaveWorkdaysPerWeek":{"oneOf":[{"description":"Workdays per week the leave entitlement is based on (written by UserContractVersion::writeToContract)","type":"number","format":"float","example":5,"uniqueKey":"contract.leaveWorkdaysPerWeek.oneOf.0","typeLabel":"number\u003cfloat>"},{"description":"Workdays per week the leave entitlement is based on (written by UserContractVersion::writeToContract)","type":"null","format":"float","example":5,"uniqueKey":"contract.leaveWorkdaysPerWeek.oneOf.1","typeLabel":"null"}],"uniqueKey":"contract.leaveWorkdaysPerWeek","typeLabel":"number\u003cfloat> | null"},"disabilityFrom":{"oneOf":[{"description":"First day of a disability status of the contract version valid today (written by UserContractVersion::writeToContract)","type":"string","format":"date","example":"2026-10-01T00:00:00.000Z","uniqueKey":"contract.disabilityFrom.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"First day of a disability status of the contract version valid today (written by UserContractVersion::writeToContract)","type":"null","format":"date","example":"2026-10-01T00:00:00.000Z","uniqueKey":"contract.disabilityFrom.oneOf.1","typeLabel":"null"}],"uniqueKey":"contract.disabilityFrom","typeLabel":"string\u003cdate> | null"},"disabilityUntil":{"oneOf":[{"description":"Last day of a disability status of the contract version valid today (written by UserContractVersion::writeToContract)","type":"string","format":"date","example":"2027-09-30T00:00:00.000Z","uniqueKey":"contract.disabilityUntil.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Last day of a disability status of the contract version valid today (written by UserContractVersion::writeToContract)","type":"null","format":"date","example":"2027-09-30T00:00:00.000Z","uniqueKey":"contract.disabilityUntil.oneOf.1","typeLabel":"null"}],"uniqueKey":"contract.disabilityUntil","typeLabel":"string\u003cdate> | null"},"salaryType":{"description":"Type of salary calculation","type":"string","enum":["hourly","monthly","450"],"example":"hourly","uniqueKey":"contract.salaryType","typeLabel":"enum\u003cstring>"},"employment":{"description":"Employment type classification","type":"string","example":"full-time","uniqueKey":"contract.employment","typeLabel":"string"},"payment":{"description":"Payment method or category","type":"string","example":"direct-deposit","uniqueKey":"contract.payment","typeLabel":"string"},"dailyWorkingHours":{"description":"Daily working hours configuration","type":"object","uniqueKey":"contract.dailyWorkingHours","typeLabel":"object"},"payTypeId":{"oneOf":[{"description":"Reference to pay type configuration","type":"string","format":"objectid","uniqueKey":"contract.payTypeId.oneOf.0","typeLabel":"string\u003cobjectid>"},{"description":"Reference to pay type configuration","type":"null","format":"objectid","uniqueKey":"contract.payTypeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"contract.payTypeId","typeLabel":"string\u003cobjectid> | null"},"vacationDays":{"description":"Number of vacation days per year","type":"integer","example":30,"uniqueKey":"contract.vacationDays","typeLabel":"integer"},"remainingLeave":{"description":"Remaining leave days from previous periods","type":"array","items":{"title":"Remaining Leave Days","description":"Tracks remaining vacation days that can be carried over from previous years","properties":{"year":{"description":"The year for which these remaining leave days apply","type":"integer","maximum":2050,"minimum":2020,"example":2023,"uniqueKey":"contract.remainingLeave.items.[INDEX].year","typeLabel":"integer"},"days":{"description":"Number of remaining leave days available to be used","type":"integer","minimum":0,"example":5,"uniqueKey":"contract.remainingLeave.items.[INDEX].days","typeLabel":"integer"}},"type":"object","uniqueKey":"contract.remainingLeave.items.[INDEX]","typeLabel":"Remaining Leave Days · object"},"uniqueKey":"contract.remainingLeave","typeLabel":"Remaining Leave Days · object[]"},"allowedToTrackDrivingTime":{"description":"Whether employee is allowed to track driving time","type":"boolean","example":true,"uniqueKey":"contract.allowedToTrackDrivingTime","typeLabel":"boolean"},"absenceDailyPayHours":{"oneOf":[{"description":"Fixed daily absence pay hours used for USER_DAILY_HOURS calculation type","type":"number","format":"float","example":6.5,"uniqueKey":"contract.absenceDailyPayHours.oneOf.0","typeLabel":"number\u003cfloat>"},{"description":"Fixed daily absence pay hours used for USER_DAILY_HOURS calculation type","type":"null","format":"float","example":6.5,"uniqueKey":"contract.absenceDailyPayHours.oneOf.1","typeLabel":"null"}],"uniqueKey":"contract.absenceDailyPayHours","typeLabel":"number\u003cfloat> | null"}},"uniqueKey":"contract","typeLabel":"Employment Contract · object"},"contact":{"description":"Contact information structure containing phone numbers, email, SMS details, and website","properties":{"telephone":{"description":"Primary telephone number","type":"string","example":"+1-555-123-4567","uniqueKey":"contact.telephone","typeLabel":"string"},"mobile":{"description":"Mobile phone number","type":"string","example":"+1-555-987-6543","uniqueKey":"contact.mobile","typeLabel":"string"},"email":{"description":"Email address","type":"string","format":"email","example":"contact@company.com","uniqueKey":"contact.email","typeLabel":"string\u003cemail>"},"sms":{"description":"SMS contact number","type":"string","example":"+1-555-111-2222","uniqueKey":"contact.sms","typeLabel":"string"},"smsCount":{"description":"Number of SMS messages sent","type":"integer","example":5,"uniqueKey":"contact.smsCount","typeLabel":"integer"},"smsChatCount":{"description":"Number of SMS chat messages","type":"integer","example":12,"uniqueKey":"contact.smsChatCount","typeLabel":"integer"},"smsSendDate":{"description":"Date when last SMS was sent","type":"string","format":"date-time","example":"2024-01-15T10:30:00.000Z","uniqueKey":"contact.smsSendDate","typeLabel":"string\u003cdate-time>"},"smsSendBy":{"description":"User ID who sent the SMS","type":"string","example":"user123","uniqueKey":"contact.smsSendBy","typeLabel":"string"},"website":{"description":"Company website URL","type":"string","format":"uri","example":"https://www.company.com","uniqueKey":"contact.website","typeLabel":"string\u003curi>"},"lastSMSStatus":{"description":"Status of the last SMS sent","type":"string","example":"delivered","uniqueKey":"contact.lastSMSStatus","typeLabel":"string"},"secondSmsSendDate":{"description":"Date when second SMS was sent","type":"string","format":"date-time","example":"2024-01-16T14:45:00.000Z","uniqueKey":"contact.secondSmsSendDate","typeLabel":"string\u003cdate-time>"}},"type":"object","uniqueKey":"contact","typeLabel":"object"},"address":{"description":"Address","properties":{"street":{"description":"Street address","type":"string","uniqueKey":"address.street","typeLabel":"string"},"zip":{"description":"ZIP/postal code","type":"string","uniqueKey":"address.zip","typeLabel":"string"},"city":{"description":"City","type":"string","uniqueKey":"address.city","typeLabel":"string"},"country":{"description":"Country","type":"string","uniqueKey":"address.country","typeLabel":"string"},"co":{"description":"Care of (c/o)","type":"string","uniqueKey":"address.co","typeLabel":"string"},"state":{"description":"State/province","type":"string","uniqueKey":"address.state","typeLabel":"string"}},"type":"object","uniqueKey":"address","typeLabel":"object"},"accessGroupId":{"description":"Access group ID defining user permissions and role within the system","type":"string","example":"service","uniqueKey":"accessGroupId","typeLabel":"string"},"jobs":{"description":"Associated jobs and assignments for the user","type":"array","items":{"type":"object","uniqueKey":"jobs.items.[INDEX]","typeLabel":"object"},"uniqueKey":"jobs","typeLabel":"object[]"},"setUpDone":{"description":"Whether initial user setup has been completed","type":"boolean","example":true,"uniqueKey":"setUpDone","typeLabel":"boolean"},"location":{"title":"GPS Location","description":"GPS coordinates and location information used for time tracking and object positioning","properties":{"latitude":{"description":"Latitude coordinate in decimal degrees","type":"number","format":"double","maximum":90,"minimum":-90,"example":48.8566,"uniqueKey":"location.latitude","typeLabel":"number\u003cdouble>"},"longitude":{"description":"Longitude coordinate in decimal degrees","type":"number","format":"double","maximum":180,"minimum":-180,"example":2.3522,"uniqueKey":"location.longitude","typeLabel":"number\u003cdouble>"},"location":{"description":"GeoJSON representation of the location for MongoDB geospatial queries. Null when no usable point is set.","type":"object","example":{"type":"Point","coordinates":[2.3522,48.8566]},"uniqueKey":"location.location","typeLabel":"object"},"source":{"description":"Where the coordinates came from. A geocoder never overwrites `manual`.","type":"string","enum":["device","nominatim","opencage","mapbox","manual"],"example":"nominatim","uniqueKey":"location.source","typeLabel":"enum\u003cstring>"},"geocodedAt":{"description":"When the point was resolved","type":"string","format":"date-time","uniqueKey":"location.geocodedAt","typeLabel":"string\u003cdate-time>"},"geocodeQuery":{"description":"The address string that produced this point","type":"string","uniqueKey":"location.geocodeQuery","typeLabel":"string"},"matchCode":{"description":"Provider-specific match quality, kept verbatim for debugging","type":"string","uniqueKey":"location.matchCode","typeLabel":"string"},"precision":{"description":"Normalized match quality across providers","type":"string","enum":["city","postcode","street","rooftop"],"uniqueKey":"location.precision","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"location","typeLabel":"GPS Location · object"},"activityTypeIds":{"description":"List of activity type IDs the user is qualified or assigned to perform","type":"array","items":{"type":"string","uniqueKey":"activityTypeIds.items.[INDEX]","typeLabel":"string"},"example":["cleaning","maintenance","inspection"],"uniqueKey":"activityTypeIds","typeLabel":"string[]"},"implementation":{"title":"User Implementation Status","description":"Tracks user onboarding progress and system integration status","properties":{"hasJob":{"description":"Whether the user has been assigned to at least one job","type":"boolean","example":true,"uniqueKey":"implementation.hasJob","typeLabel":"boolean"},"hasTimeTracking":{"description":"Whether the user has started using time tracking functionality","type":"boolean","example":true,"uniqueKey":"implementation.hasTimeTracking","typeLabel":"boolean"},"isSuccessfullyImplemented":{"description":"Whether the user has completed the full implementation/onboarding process","type":"boolean","example":false,"uniqueKey":"implementation.isSuccessfullyImplemented","typeLabel":"boolean"},"lastTimeActive":{"oneOf":[{"description":"Timestamp of the user's last activity in the system","type":"string","format":"date-time","example":"2023-12-01T14:30:00.000Z","uniqueKey":"implementation.lastTimeActive.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Timestamp of the user's last activity in the system","type":"null","format":"date-time","example":"2023-12-01T14:30:00.000Z","uniqueKey":"implementation.lastTimeActive.oneOf.1","typeLabel":"null"}],"uniqueKey":"implementation.lastTimeActive","typeLabel":"string\u003cdate-time> | null"}},"type":"object","uniqueKey":"implementation","typeLabel":"User Implementation Status · object"},"workedOnObjectIds":{"description":"Array of customer object IDs the user has worked on","type":"array","items":{"type":"string","format":"objectid","uniqueKey":"workedOnObjectIds.items.[INDEX]","typeLabel":"string\u003cobjectid>"},"example":["507f1f77bcf86cd799439011","507f191e810c19729de860ea"],"uniqueKey":"workedOnObjectIds","typeLabel":"string\u003cobjectid>[]"},"tags":{"oneOf":[{"description":"Tags for categorizing and filtering users","type":"array","items":{"type":"string","uniqueKey":"tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"example":["full-time","certified","team-lead"],"uniqueKey":"tags.oneOf.0","typeLabel":"string[]"},{"description":"Tags for categorizing and filtering users","type":"null","items":{"type":"string"},"example":["full-time","certified","team-lead"],"uniqueKey":"tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags","typeLabel":"string[] | null"},"analytics":{"title":"User Analytics Data","description":"Analytics and performance tracking information for users","properties":{"createdProfile":{"oneOf":[{"description":"Timestamp when the user profile was created or completed","type":"string","format":"date-time","example":"2023-01-15T09:00:00.000Z","uniqueKey":"analytics.createdProfile.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Timestamp when the user profile was created or completed","type":"null","format":"date-time","example":"2023-01-15T09:00:00.000Z","uniqueKey":"analytics.createdProfile.oneOf.1","typeLabel":"null"}],"uniqueKey":"analytics.createdProfile","typeLabel":"string\u003cdate-time> | null"}},"type":"object","uniqueKey":"analytics","typeLabel":"User Analytics Data · object"}},"uniqueKey":"","typeLabel":"User · object"},"examples":{"Example":{"title":"Example","value":{"_id":"\u003cstring>","number":123,"companyId":"\u003cstring>","status":{"status":123,"createdAt":"2023-11-07T05:31:56Z","createdBy":"\u003cstring>","lastModifiedAt":"2023-11-07T05:31:56Z","lastModifiedBy":"\u003cstring>","agentId":"\u003cstring>","assistantId":"\u003cstring>"},"chatId":"\u003cstring>","id":"36920","general":{"firstName":"John","lastName":"Doe","sex":"male","birthDate":"15.08.1990","language":"de","deviceToken":"dGhpcyBpcyBhIHRva2VuIGV4YW1wbGU=","webPushToken":"BKP4z...","profileImage":"https://example.com/profiles/user123.jpg","description":"Team lead with 5 years experience","lastNpsScoreSend":"2023-11-07T05:31:56Z","badges":[{"type":"experience","level":"senior"}],"myTutorialUsername":"mytutorial_user123"},"access":{"dashboardAccess":true,"webAccess":"1","token":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","email":"user@company.com","loginTries":0,"passwordChangeToken":"reset-token-12345","passwordChangeDate":"2023-12-01T10:30:00.000Z"},"contract":{"startDate":"2023-11-07T05:31:56Z","endDate":"2023-11-07T05:31:56Z","department":"service","salary":15.5,"annualLeaveEntitlement":30,"leaveWorkdaysPerWeek":5,"disabilityFrom":"2026-10-01T00:00:00.000Z","disabilityUntil":"2027-09-30T00:00:00.000Z","salaryType":"hourly","employment":"full-time","payment":"direct-deposit","dailyWorkingHours":{},"payTypeId":"\u003cstring>","vacationDays":30,"remainingLeave":[{"year":2023,"days":5}],"allowedToTrackDrivingTime":true,"absenceDailyPayHours":6.5},"contact":{"telephone":"+1-555-123-4567","mobile":"+1-555-987-6543","email":"contact@company.com","sms":"+1-555-111-2222","smsCount":5,"smsChatCount":12,"smsSendDate":"2024-01-15T10:30:00.000Z","smsSendBy":"user123","website":"https://www.company.com","lastSMSStatus":"delivered","secondSmsSendDate":"2024-01-16T14:45:00.000Z"},"address":{"street":"\u003cstring>","zip":"\u003cstring>","city":"\u003cstring>","country":"\u003cstring>","co":"\u003cstring>","state":"\u003cstring>"},"accessGroupId":"service","jobs":[{}],"setUpDone":true,"location":{"latitude":48.8566,"longitude":2.3522,"location":{"type":"Point","coordinates":[2.3522,48.8566]},"source":"nominatim","geocodedAt":"2023-11-07T05:31:56Z","geocodeQuery":"\u003cstring>","matchCode":"\u003cstring>","precision":"city"},"activityTypeIds":["cleaning","maintenance","inspection"],"implementation":{"hasJob":true,"hasTimeTracking":true,"isSuccessfullyImplemented":false,"lastTimeActive":"2023-12-01T14:30:00.000Z"},"workedOnObjectIds":["507f1f77bcf86cd799439011","507f191e810c19729de860ea"],"tags":["full-time","certified","team-lead"],"analytics":{"createdProfile":"2023-01-15T09:00:00.000Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"0804b0df-f4fa-4ac4-a110-566ec6b22dc4":{"description":"Unauthorized - Authentication required","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"038da2f4-567d-43da-8ba1-18791dab8491":{"description":"Forbidden - Insufficient permissions","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"cb91d71f-0178-4cc7-a7fd-91d43a082898":{"description":"User not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"9b1d9a37-8595-4641-a214-da2139534a02":{"description":"Internal server error","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"7f117203-2981-4138-a052-58b724ec5773":{"API-Key":{"type":"apiKey","name":"x-API-Key","in":"header","scopes":[],"schemeName":"API-Key"}},"e4f4e05f-c6e7-4d0d-8d4b-d830fb1b8a27":{"Bearer-Auth":{"type":"http","bearerFormat":"JWT","scheme":"bearer","scopes":[],"schemeName":"Bearer-Auth"}}},"servers":{"049f04bf-2709-4eaa-8561-4ab663e714af":{"url":"https://cloud-api.pland.app/v2","description":"Production Server"},"c9c1a3f9-30ec-4c06-b6dc-9dac055b68a8":{"url":"https://beta-api.pland.app/v2","description":"Sandbox Server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"x-API-Key","in":"header","scopes":[],"schemeName":"API-Key"},"schema":{"title":"x-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"API-Key","name":"x-API-Key"}],"title":"API-Key"},{"schemes":[{"scheme":{"type":"http","bearerFormat":"JWT","scheme":"bearer","scopes":[],"schemeName":"Bearer-Auth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Bearer-Auth","name":"Authorization"}],"title":"Bearer-Auth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"pland","siteName":"Pland Developer Platform","title":"Get User - Pland Developer Platform","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-11-17T11:03:32.257Z","originalFileLocation":"api-reference/users/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=\"Retrieves a user by their ID. Use \u0026quot;self\u0026quot; as ID to get the authenticated user\u0026#x27;s own information.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Pland Developer Platform\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get User - Pland Developer Platform\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves a user by their ID. Use \u0026quot;self\u0026quot; as ID to get the authenticated user\u0026#x27;s own information.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pland Developer Platform\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pland.app/api-reference/users/get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pland.mintlify.site/_mintlify/api/og/v2?division=Users\u0026amp;title=Get+User\u0026amp;description=Retrieves+a+user+by+their+ID.+Use+%22self%22+as+ID+to+get+the+authenticated+user%27s+own+information.\u0026amp;theme=79a9502ef2604cadbd145a60\u0026amp;signature=249b4c083e6df1a665300fafcb69d4be62e6b876fbe1c0e3711023403d995fbb\">\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 User - Pland Developer Platform\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves a user by their ID. Use \u0026quot;self\u0026quot; as ID to get the authenticated user\u0026#x27;s own information.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pland.mintlify.site/_mintlify/api/og/v2?division=Users\u0026amp;title=Get+User\u0026amp;description=Retrieves+a+user+by+their+ID.+Use+%22self%22+as+ID+to+get+the+authenticated+user%27s+own+information.\u0026amp;theme=79a9502ef2604cadbd145a60\u0026amp;signature=249b4c083e6df1a665300fafcb69d4be62e6b876fbe1c0e3711023403d995fbb\">\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/pland/T_oVkU3Prt9hFyNK/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Pland Developer Platform\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pland.app/api-reference/users/get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/users/get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pland.app/#organization\",\"name\":\"Pland Developer Platform\",\"url\":\"https://docs.pland.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pland/4nF818XuJvdH1X-y/logo/logo-light.png?fit=max\u0026auto=format\u0026n=4nF818XuJvdH1X-y\u0026q=85\u0026s=58e21d630b18eebde27bee10fa752eb3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pland.app#website\",\"name\":\"Pland Developer Platform\",\"url\":\"https://docs.pland.app\",\"publisher\":{\"@id\":\"https://docs.pland.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pland.app/api-reference/users/get#webpage\",\"url\":\"https://docs.pland.app/api-reference/users/get\",\"name\":\"Get User\",\"description\":\"Retrieves a user by their ID. Use \\\"self\\\" as ID to get the authenticated user's own information.\",\"dateModified\":\"2025-11-17T11:03:32.257Z\",\"isPartOf\":{\"@id\":\"https://docs.pland.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pland.app/api-reference/users/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pland.app/api-reference/users/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Users\",\"item\":\"https://docs.pland.app/api-reference/users/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get User\",\"item\":\"https://docs.pland.app/api-reference/users/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pland.app/api-reference/users/get#apireference\",\"headline\":\"Get User\",\"name\":\"Get User\",\"description\":\"Retrieves a user by their ID. Use \\\"self\\\" as ID to get the authenticated user's own information.\",\"url\":\"https://docs.pland.app/api-reference/users/get\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pland.app/api-reference/users/get#webpage\"},\"dateModified\":\"2025-11-17T11:03:32.257Z\",\"publisher\":{\"@id\":\"https://docs.pland.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pland.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Pland Developer Platform\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Pland Developer Platform","nav":{"global":{"anchors":[{"anchor":"Roadmap","icon":"road","href":"https://feedback.pland.app/de/roadmap/main"},{"anchor":"Changelog","icon":"bullhorn","href":"https://feedback.pland.app/de/changelog"},{"anchor":"Knowledge Base","icon":"book","href":"https://help.pland.app"}]},"tabs":[{"tab":"Introduction","hidden":false,"pages":[{"title":"Introduction","href":""}]},{"tab":"API Reference","hidden":false,"groups":[{"group":"Getting Started","pages":[{"title":"Authentication","href":"/api-reference/getting-started/authentication"},{"title":"Pagination","href":"/api-reference/getting-started/pagination"},{"title":"Sorting","href":"/api-reference/getting-started/sorting"}]},{"group":"Users","pages":[{"title":"List Users","openapi":"GET /users/","description":"List all users in the system with optional filtering, pagination, and sorting capabilities. Supports advanced filtering by name, employment, status, tags, time availability, and more.","href":"/api-reference/users/list"},{"title":"Get User","openapi":"GET /users/{id}","href":"/api-reference/users/get"},{"title":"Get User by Number","openapi":"GET /users/{userNumber}/byNumber","description":"Retrieves a user by their employee number","href":"/api-reference/users/get-by-number"},{"title":"Get Last Number","openapi":"GET /users/lastNumber","href":"/api-reference/users/get-last-number"},{"title":"Create User","openapi":"POST /users/","href":"/api-reference/users/create"},{"title":"Delete User","openapi":"DELETE /users/{id}","href":"/api-reference/users/delete"},{"title":"Update User","openapi":"PATCH /users/{id}","href":"/api-reference/users/update"},{"title":"Send Invite SMS to User","openapi":"POST /users/{id}/generatePassword","href":"/api-reference/users/send-invite-sms"}]},{"group":"Salaries","pages":[{"title":"List Salaries","openapi":"GET /salaries/","href":"/api-reference/salaries/list"},{"title":"Export Salary Rows","openapi":"POST /salaries/exportSalaryRows","href":"/api-reference/salaries/export-rows"}]},{"group":"Jobs","pages":[{"title":"List Open Jobs","openapi":"GET /jobs/notAssigned","href":"/api-reference/jobs/list-open"},{"title":"List Jobs in Timeframe","openapi":"POST /jobs/jobsInTimeFrame","href":"/api-reference/jobs/list-in-timeframe"},{"title":"Update a Job","openapi":"PATCH /jobs/{id}/v2","href":"/api-reference/jobs/update"}]},{"group":"Time Tracking","pages":[{"title":"List Time Trackings","openapi":"GET /timetracking/list","href":"/api-reference/time-tracking/list"}]},{"group":"Objects","pages":[{"title":"List Objects","openapi":"GET /objects/","href":"/api-reference/objects/list"},{"title":"Get Object","openapi":"GET /objects/{id}","href":"/api-reference/objects/get"},{"title":"Get Object by Number","openapi":"GET /objects/{objectNumber}/byNumber","href":"/api-reference/objects/get-by-number"},{"title":"Get Last Number","openapi":"GET /objects/lastNumber","href":"/api-reference/objects/get-last-number"},{"title":"Create Object","openapi":"POST /objects/","href":"/api-reference/objects/create"},{"title":"Update Object","openapi":"PATCH /objects/{id}","href":"/api-reference/objects/update"}]},{"group":"Customers","pages":[{"title":"List Customers","openapi":"GET /customers/","href":"/api-reference/customers/list"},{"title":"Get Customer","openapi":"GET /customers/{id}","href":"/api-reference/customers/get"},{"title":"Get Last Customer Number","openapi":"GET /customers/lastNumber","href":"/api-reference/customers/get-last-number"},{"title":"Create Customer","openapi":"POST /customers/","href":"/api-reference/customers/create"},{"title":"Update Customer","openapi":"PATCH /customers/{id}","href":"/api-reference/customers/update"},{"title":"Batch Update Customers","openapi":"PATCH /customers/many","href":"/api-reference/customers/batch-update"}]},{"group":"Equipment","pages":[{"title":"List Equipment","openapi":"GET /equipment/","href":"/api-reference/equipment/list"},{"title":"Get Equipment","openapi":"GET /equipment/{id}","href":"/api-reference/equipment/get"},{"title":"Create Equipment","openapi":"POST /equipment/","href":"/api-reference/equipment/create"},{"title":"Update Equipment","openapi":"PATCH /equipment/{id}","href":"/api-reference/equipment/update"},{"title":"Batch Update Equipment","openapi":"PATCH /equipment/many","href":"/api-reference/equipment/batch-update"}]},{"group":"Articles","pages":[{"title":"List Articles","openapi":"GET /articles/","href":"/api-reference/articles/list"},{"title":"Get Article","openapi":"GET /articles/{id}","href":"/api-reference/articles/get"},{"title":"Get Last Number","openapi":"GET /articles/lastNumber","href":"/api-reference/articles/get-last-number"},{"title":"Create Article","openapi":"POST /articles/","href":"/api-reference/articles/create"},{"title":"Update Article","openapi":"PATCH /articles/{id}","href":"/api-reference/articles/update"}]},{"group":"Tasks","pages":[{"title":"List Tasks","openapi":"GET /tasks/","href":"/api-reference/tasks/list"},{"title":"Get Task","openapi":"GET /tasks/{id}","href":"/api-reference/tasks/get"},{"title":"Complete Task","openapi":"POST /tasks/{id}/complete","href":"/api-reference/tasks/complete"},{"title":"Create Task","openapi":"POST /tasks/","href":"/api-reference/tasks/create"},{"title":"Update Task","openapi":"PATCH /tasks/{id}","href":"/api-reference/tasks/update"},{"title":"Delete Tasks","openapi":"POST /tasks/delete","href":"/api-reference/tasks/delete"},{"title":"Task forms","openapi":"GET /tasks/{id}/forms","href":"/api-reference/tasks/get-task-forms"}]},{"group":"Task Types","pages":[{"title":"List Task Types","openapi":"GET /taskTypes/","href":"/api-reference/task-types/list"},{"title":"Get Task Type","openapi":"GET /taskTypes/{id}","href":"/api-reference/task-types/get"},{"title":"Create Task Type","openapi":"POST /taskTypes/","href":"/api-reference/task-types/create"},{"title":"Update Task Type","openapi":"PATCH /taskTypes/{id}","href":"/api-reference/task-types/update"},{"title":"Delete Task Type","openapi":"DELETE /taskTypes/{id}","href":"/api-reference/task-types/delete"}]},{"group":"Absences","pages":[{"title":"List Absences","openapi":"GET /absences/","href":"/api-reference/absences/list"},{"title":"Get Absence","openapi":"GET /absences/{id}","href":"/api-reference/absences/get"},{"title":"Create Absence","openapi":"POST /absences/","href":"/api-reference/absences/create"},{"title":"Update Absence","openapi":"PATCH /absences/{id}","href":"/api-reference/absences/update"},{"title":"List Personal Absences","openapi":"GET /absences/self","href":"/api-reference/absences/list-self"}]},{"group":"Material Orders","pages":[{"title":"List Material Orders","openapi":"GET /orders/","href":"/api-reference/material-orders/list"},{"title":"Get Material Order","openapi":"GET /orders/{id}","href":"/api-reference/material-orders/get"},{"title":"Create Material Order","openapi":"POST /objects/{objectId}/order","href":"/api-reference/material-orders/create"},{"title":"Update Material Order","openapi":"PATCH /orders/{id}","href":"/api-reference/material-orders/update"}]},{"group":"Quality Control","pages":[{"title":"List Quality Controls","openapi":"GET /qualityControl/","href":"/api-reference/quality-control/list"},{"title":"Get Quality Control","openapi":"GET /qualityControl/{id}","href":"/api-reference/quality-control/get"},{"title":"Create Quality Control","openapi":"POST /qualityControl/","href":"/api-reference/quality-control/create"},{"title":"List Quality Control by Object","openapi":"GET /qualityControl/object/{objectId}","href":"/api-reference/quality-control/list-by-object"},{"title":"List Quality Control by Object Manager","openapi":"GET /qualityControl/objectManager/{id}","href":"/api-reference/quality-control/list-by-object-manager"}]},{"group":"Documents","pages":[{"title":"List Documents","openapi":"GET /documents/","href":"/api-reference/documents/list"},{"title":"Get Document","openapi":"GET /documents/{id}","href":"/api-reference/documents/get"},{"title":"Upload Documents","openapi":"POST /documents/","href":"/api-reference/documents/create"},{"title":"Update Document","openapi":"PATCH /documents/{id}","href":"/api-reference/documents/update"},{"title":"Delete Document","openapi":"DELETE /documents/{id}","href":"/api-reference/documents/delete"},{"title":"List Documents for Entity","openapi":"GET /{entity}/{id}/documents","href":"/api-reference/documents/list-by-entity"},{"title":"Create Document from URL","openapi":"POST /documents/withUrl","href":"/api-reference/documents/create-from-url"},{"title":"Get document tags","openapi":"GET /documents/tags","href":"/api-reference/documents/get-document-tags"}]},{"group":"Logbuch","pages":[{"title":"Send Message","openapi":"POST /chat/v2/{id}/send","href":"/api-reference/logbuch/send-message"},{"title":"Send Note","openapi":"POST /chat/v2/{id}/sendNote","href":"/api-reference/logbuch/send-note"}]},{"group":"Webhooks","pages":[{"title":"List Webhooks","openapi":"GET /integrations/webhooks/","href":"/api-reference/webhooks/list"},{"title":"Create Webhook","openapi":"POST /integrations/webhooks/","href":"/api-reference/webhooks/create"},{"title":"Update Webhook","openapi":"PATCH /integrations/webhooks/{id}","href":"/api-reference/webhooks/update"},{"title":"Delete Webhook","openapi":"DELETE /integrations/webhooks/{id}","href":"/api-reference/webhooks/delete"}]}]},{"tab":"Guides"}]},"basePath":"","title":"Get User - Pland Developer Platform","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}