---
title: "Search all accounts"
method: GET
path: "/api/creditcontrol/accounts"
tags: ["Account"]
---

# Search all accounts

`GET /api/creditcontrol/accounts`

Retrieves a list of all [customer credit accounts](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU) 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](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** |
| --------------- | ----------------- | ----------------- |
| Credit Control | Main | **Main Access** |
| Credit Control | Checking Accounts | **Read Checking Accounts** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Query parameters

- `from` string
- `to` string
- `status` 'Opened' | 'Paid' | 'Cancelled'
- `email` string

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- object
  - `data` object[], required — Data information.
    - `id` string, required — Credit customer account identification.
    - `balance` number, required — Account balance value. If this number is negative, it means that the account has a debit instead of a credit to be used.
    - `document` string, required — Account owner document.
    - `status` 'Open' | 'Closed', required — Credit customer account status. This value will always come as `Open`. If an account is closed (`Closed`), it will not be displayed in the response body of this endpoint.
    - `documentType` 'CPF' | 'CNPJ' | 'Other', required — Document type.
    - `creditLimit` number, required — Maximum credit amount on the account.
    - `updatedAt` string, required — Date of the last update made to the account.
    - `createdAt` string, required — Account creation date.
    - `description` string — This field is deprecated.
    - `availableCredit` number, required — Credit amount available on the account.
    - `preAuthorizedCredit` number, required — Credit value that can only be used by the account owner after the merchant releases a specific purchase transaction.
    - `email` string, required — Account owner email.
    - `tolerance` number, required — Account credit tolerance (in decimals). This value represents the increase in credit on an account. For example, a value of `0.30` indicates that the account owner can use up to 30% above the account's original maximum credit amount.
    - `availableBalance` number, required — Balance available for use on the account.
  - `summary` object, required — Summary information.
    - `count` integer, required — Number of customer credit accounts in the store.

---

[API](https://skmtc.net/vtex/apis/customer-credit-api.md) · [All operations](https://skmtc.net/vtex/apis/customer-credit-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/customer-credit-api/versions/6397d4efe3b7/schema)