---
title: "Listas todas as contas cadastradas"
method: GET
path: "/escrow/api/v1/accounts"
tags: ["Contas"]
---

# Listas todas as contas cadastradas

`GET /escrow/api/v1/accounts`

## Request

- Base URL: `https://sandbox.platform.credit.celcoin.com.br`
- URL: `https://sandbox.platform.credit.celcoin.com.br/escrow/api/v1/accounts`
- Auth: none declared

Esse endpoint é responsável por retornar uma lista paginada de contas escrow cadastradas. É possível realizar uma série de filtros, ordenações e navegar entre as páginas de resultados.

#### Parâmetros da Requisição

- `status` (string): Status da conta. Possíveis valores aceitos: CREATING, ERROR_CREATING, PENDING_ACTIVATION, ACTIVE, BLOCKING, ERROR_BLOCKING, UNBLOCKING, ERROR_UNBLOCKING, BLOCKED, CANCELING, ERROR_CANCELING, CANCELED.
    
- `personId` (string/uuid v4): ID para filtro de contas de uma Pessoa.
    
- `taxpayerId` (string): Nº do CPF ou CNPJ do pagador.
    
- `account` (string): ID da conta para consulta das solicitações
    
- `creatorName` (string): Nome do criador da conta.
    
- `sort` (string): Campo para ordenação dos resultados. Possíveis valores: id, createdAt, status, account.
    

#### Resposta

Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato:

- `content`(object list): Objeto contendo a lista com o resultado do filtro realizado.
    
- `hasNext` (boolean): Campo para indicar se tem uma próxima página.
    
- `totalElements` (int): Quantidade total de registros retornados para a busca realizada.
    
- `totalPages` (int): Quantidade total de páginas retornadas para a busca realizada.
    

##### Objeto 'content'

- `id` (string): ID para identificação da conta escrow.
    
- `status` (string): Status do conta. Possíveis valores: CREATING, ERROR_CREATING, PENDING_ACTIVATION, ACTIVE, BLOCKING, ERROR_BLOCKING, UNBLOCKING, ERROR_UNBLOCKING, BLOCKED, CANCELING, ERROR_CANCELING, CANCELED.
    
- `person` (object): Objeto contendo os dados da Pessoa.
    
- `person -> id` (string): ID de cadastro da Pessoa.
    
- `person -> name` (string): Nome da Pessoa
    
- `person -> taxpayerId` (string): Número do CPF da Pessoa
    
- `person -> personType` (string): Tipo da Pessoa. Possíveis valores: LEGAL, PERSON
    
- `creator` (object): Objeto contendo os dados de quem fez o cadastro da conta.
    
- `creator -> id` (string): ID de cadastro.
    
- `creator -> fullname` (string): Nome completo.
    
- `creator -> taxpayerId` (string): Número do CPF.
    
- `createdAt` (datetime): Data da criação da conta.
    
- `account` (string): Número da conta.
    
- `error` (string): Retorno em caso de algum erro na geração da conta.
    

##### Exemplo de JSON:

``` json
{
  "content": [
    {
      "id": "<string>",
      "person": {
        "id": "<string>",
        "name": "<string>",
        "taxpayerId": "<string>",
        "personType": "LEGAL"
      },
      "creator": {
        "id": "<string>",
        "fullName": "<string>",
        "taxpayerId": "<string>"
      },
      "createdAt": "<string>",
      "status": "ERROR_CANCELING",
      "account": "<string>",
      "error": "<string>"
    }
  ],
  "hasNext": "<boolean>",
  "totalElements": "<number>",
  "totalPages": "<number>"
}

 ```

## Headers

- `Accept` string

## Response `200`

OK

- object

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden

---

[API](https://skmtc.dev/celcoin/apis/celcoin-escrow.md) - [All operations](https://skmtc.dev/celcoin/apis/celcoin-escrow/llms.txt) - [OpenAPI document](https://skmtc.dev/celcoin/apis/celcoin-escrow/revisions/5d55a35a6d51?raw)