--- title: "Get information about account" method: GET path: "/api/vlm/account" tags: ["Account"] --- # Get information about account `GET /api/vlm/account` Retrieves information from an account, such as company and sponsor user details, stores, and appTokens. This endpoint only accepts requests from the host list designated for that store. If you want to try this request from this portal, be sure to add it to the list. Learn how to add hosts to the list in [How to manage accounts](https://help.vtex.com/en/tutorial/how-to-manage-accounts--tutorials_6285#). ## Permissions Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint: | **Product** | **Category** | **Resource** | | --------------- | ----------------- | ----------------- | | License Manager | Services access control | **Save account** | You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy): | **Role** | **Resource** | | --------------- | ----------------- | | Finance - Full access | Save account | >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication). ## Response `200` Success - AccountResponse — Successful response for `/api/vlm/account`. - `isActive` boolean — Defines if the account is active (`true`) or not (`false`). - `id` string — ID of the account. - `name` string — Trading name. - `accountName` string — Account name. - `lv` string, nullable — Level. - `isOperating` boolean — Defines if the account is in production (`true`) or not (`false`). - `defaultUrl` string, nullable — Default URL. - `district` string, nullable — Neighborhood of the person assigned as main contact of the store. - `country` string, nullable — Country of the person assigned as main contact of the store. - `complement` string, nullable — Additional address of the person assigned as main contact of the store. - `companyName` string — Company name. - `cnpj` string, nullable — CNPJ (Corporate Tax ID) of account. - `haveParentAccount` boolean — Defines if the account has a parent account (`true`) or not (`false`). - `parentAccountId` string, nullable — ID of the parent account. - `parentAccountName` string, nullable — Name of the parent account. - `city` string, nullable — City of the person assigned as main contact of the store. - `address` string, nullable — Address of the person assigned as main contact of the store. - `logo` string, nullable — Filename of the account's logotype. - `hasLogo` boolean — Defines if the store's logotype has been uploaded (`true`) or not (`false`). - `number` string, nullable — Number of the address of the person assigned as main contact of the store. - `postalCode` string, nullable — Zip code of the person assigned as main contact of the store. - `state` string, nullable — State or province of the person assigned as main contact of the store. - `telephone` string — Telephone number of the person assigned as main contact of the store. - `tradingName` string — Trading name. - `licenses` LicenseItems[] — Licenses of the account. - `expiration` string, date-time, nullable — Expiration date. - `id` number — ID of the category of the license. - `isPurchased` boolean — Defines if the license is purchased (`true`) or not (`false`). - `products` object[] — Array of products. - `id` number — ID of the product. - `name` string — Name of the product. - `domains` string[] — List of domains of the product. - `endpoints` object — Endpoints. - `webApiUrl` string, nullable — Web API URL. - `consoleUrl` string, nullable — Console URL. - `name` string — Name of the category of the license. - `sponsor` object — Object with information about the sponsor user. - `name` string — Name of the sponsor user. - `email` string — Email of the sponsor user. - `phone` string — Phone of the sponsor user. - `contact` object — Information about the person assigned as main contact of the store. - `name` string — Name of the person assigned as main contact of the store. - `email` string — Email of the person assigned as main contact of the store. - `phone` string — Telephone number of the person assigned as main contact of the store. - `operationDate` string, date-time, nullable — Date when the account went into production. - `inactivationDate` string, date-time, nullable — Date when the account was deactivated. - `creationDate` string, date-time — Date when the account was created. - `hosts` string[] — Hosts of all stores. - `sites` SiteItems[] — Array of objects representing each store. - `id` number — ID of the store. - `name` string — Store name. - `tradingName` string — Trading name of the store. - `LV` string, nullable — Level. - `logo` string, nullable — Logo. - `monetaryUnitId` number — Monetary unit ID. - `domains` string[], nullable — List of domains. - `hosts` string[] — Hosts associated to the store. - `aliases` string[] — Aliases. - `appKey` object — Deprecated. Check the `appKeys` object for all API keys. - `token` string, nullable — Token. - `name` string, nullable — Token name. - `appKeys` AppKeyItems[] — Array of application keys. - `id` string — ID of the API key. - `appKey` string — API key. - `appToken` string, nullable — API token. For security reasons, it should always be null. - `label` string — Label of the API key. - `createdIn` string, date-time — Creation date of the API key. - `isActive` boolean — Defines if the API key is active (`true`) or not (`false`). - `isBlocked` boolean — Defines if the API key is blocked (`true`) or not (`false`). ## Changes - **2024-01-22** `9c85a2787ce9` — 2 info - response property `sites/items/aliases/items/` deprecated - response property `sites/items/domains/items/` deprecated - **2022-01-28** `ca8bd421f133` — 2 warning - deleted the `path` request parameter `accountName` - deleted the `path` request parameter `environment` - **2021-11-16** `000842297d2a` — 1 warning, 13 info - removed the optional property `licenses/items/endpoints` from the response with the `200` status - added the optional property `licenses/items/isPurchased` to the response with the `200` status - added the optional property `licenses/items/products` to the response with the `200` status - response property `appKey` deprecated - …10 more - **2021-11-09** `7a2ee1e98a24` — 1 info - added the media type `application/json` for the response with the status `200` - **2021-10-28** `e1d08a8a5e44` — 1 info - api operation id `Get` removed and replaced with `GetAccount` [Change history](https://skmtc.dev/vtex/apis/license-manager-api/changes/api/vlm/account/get.md) --- [API](https://skmtc.dev/vtex/apis/license-manager-api.md) · [All operations](https://skmtc.dev/vtex/apis/license-manager-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vtex/license-manager-api/revisions/a7dd68911d51/schema)