--- title: "Get user account information" method: GET path: "/v2/user/customer/account" tags: ["Customer - Account"] --- # Get user account information `GET /v2/user/customer/account` ## Headers - `If-None-Match` string ## Response `200` User account information - AccountInfo - `userId` string, guid, required — The user identifier - `email` string, email, required — The email - `commercialOwnerEmail` string, email — The email - `csmOwner` string — The csm owner of the acccount. - `personalInfo` PersonalInfo - `lastName` string, required — Your last name - `firstName` string, required — Your first name - `phoneNumber` string, required — Your phone number - `whatIDo` string — Your role in your company - `beezUPTimeZoneId` integer, required — The time zone identifier based on the list of values /v2/user/lov/BeezUPTimeZone - `status` 'Active' | 'SystemBlocked' | 'UserBlocked' | 'NotActivated', required — The account status * Active: When the account is active * SystemBlocked: When all stores on the account are blocked by the system * UserBlocked: When all stores on the account are blocked on GO not on the system * NotActivated: When the email is not verified - `companyInfo` CompanyInfo - `address` string, required — Your address - `postalCode` string, required — Your address postal code - `city` string, required — Your address city - `countryIsoCodeAlpha3` string, required — The country iso code alpha 3 (ISO 3166-1_alpha-3) - `company` string, required — Your company name - `vatNumber` string — Your company VATNumber. Used for french company. This number is checked with official web service before being saved. - `accountingEmails` BeezUPCommonEmail[] — Your company accounting emails - `profilePictureUrl` string — Indicate the url of your picture profil - `links` AccountInfoLinks, required — The different actions you can make on this account - `self` LinksGetUserAccountInfoLink, required - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `savePersonalInfo` LinksSavePersonalInfoLink, required - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `changeEmail` LinksChangeEmailLink, required - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `changePassword` LinksChangePasswordLink, required - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `saveCompanyInfo` LinksSaveCompanyInfoLink, required - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `getProfilePictureInfo` LinksGetProfilePictureInfoLink, required - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `saveProfilePictureInfo` LinksSaveProfilePictureInfoLink, required - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `getCreditCardInfo` LinksGetCreditCardInfoLink, required - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `saveCreditCardInfo` LinksSaveCreditCardInfoLink, required - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `activateUserAccount` LinksActivateUserAccountLink - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string ## Other responses - `304` — The ETag sent in the http header If-None-Match did not change. So you are up to date ! - `default` — Occurs when something goes wrong --- [API](https://skmtc.net/beezup/apis/beezup-merchant-api.md) · [All operations](https://skmtc.net/beezup/apis/beezup-merchant-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/beezup/beezup-merchant-api/revisions/557b7feddf8a/schema)