Search all accounts

Retrieves a list of all customer credit accounts in the store.

ℹ️ You can use the queries below (individually or combined) to obtain a more accurate search result. If your store has more than 20 customer credit accounts and you do not use any queries in the call, only the first 20 account records will appear in the response body.

ℹ️ Query params can be used individually or combined.

Queries to filter results

• By the location of the accounts in the list (quantity of accounts): ?from={int}&to={int}
• By status: ?status={Open, Closed or Cancelled}
• By email: ?email={string}

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:

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.