v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-291317322.2 KB

Account

Get information about 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.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources 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 with that resource or use one of the following predefined roles:

Role	Resource
Finance - Full access	Save account

❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. 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.

To learn more about machine authentication at VTEX, see Authentication overview.

get/api/vlm/account

Response

Success

isActiveboolean

Defines if the account is active (true) or not (false).

idstring

ID of the account.

namestring

Trading name.

accountNamestring

Account name.

lvstring nullable

Level.

isOperatingboolean

Defines if the account is in production (true) or not (false).

defaultUrlstring nullable

Default URL.

districtstring nullable

Neighborhood of the person assigned as main contact of the store.

countrystring nullable

Country of the person assigned as main contact of the store.

complementstring nullable

Additional address of the person assigned as main contact of the store.

companyNamestring

Company name.

cnpjstring nullable

CNPJ (Corporate Tax ID) of account.

haveParentAccountboolean

Defines if the account has a parent account (true) or not (false).

parentAccountIdstring nullable

ID of the parent account.

parentAccountNamestring nullable

Name of the parent account.

citystring nullable

City of the person assigned as main contact of the store.

addressstring nullable

Address of the person assigned as main contact of the store.

logostring nullable

Filename of the account's logotype.

hasLogoboolean

Defines if the store's logotype has been uploaded (true) or not (false).

numberstring nullable

Number of the address of the person assigned as main contact of the store.

postalCodestring nullable

Zip code of the person assigned as main contact of the store.

statestring nullable

State or province of the person assigned as main contact of the store.

telephonestring

Telephone number of the person assigned as main contact of the store.

tradingNamestring

Trading name.

operationDatestring date-time nullable

Date when the account went into production.

inactivationDatestring date-time nullable

Date when the account was deactivated.

creationDatestring date-time

Date when the account was created.

hostsstring[]

Hosts of all stores.