---
title: "Consulta de Contatos da Conta"
method: GET
path: "/accounts/{account}/contacts"
---

# Consulta de Contatos da Conta

`GET /accounts/{account}/contacts`

## Request

- Base URL: `https://sandbox.openfinance.celcoin.dev/baas/v2`
- URL: `https://sandbox.openfinance.celcoin.dev/baas/v2/accounts/{account}/contacts`
- Auth: OAuth 2

## Path parameters

- `account` string, required

## Query parameters

- `key` string
- `contactId` string
- `accountCredit` string
- `clientRequestId` string
- `page` integer
- `limitPerPage` integer

## Response `200`

- object
  - `status` string: Status do processamento da requisição. Retorna SUCCESS quando a consulta é realizada com sucesso.
  - `version` string: Versão do contrato da resposta.
  - `body` object
    - `account` string: Identificador da conta consultada.
    - `clientRequestId` string: Identificador único informado pelo cliente na consulta, devolvido como veio.
    - `totalItems` integer: Quantidade total de contatos encontrados conforme os filtros aplicados
    - `totalPages` integer: Quantidade total de páginas disponíveis para os parâmetros de paginação utilizados.
    - `currentPage` integer: Número da página retornada
    - `favorites` object[]: Contatos ativos da página consultada.
      - `contactId` string: Identificador único do contato.
      - `isFavorite` boolean
      - `alias` string: Nome ou apelido utilizado para identificar o contato.
      - `status` string: Status do contato. No exemplo, ACTIVE
      - `clientRequestId` string: Identificador da solicitação informado pelo cliente no cadastro.
      - `creditParty` object: Dados do destinatário vinculado ao contato.
        - `bank` string: Código da instituição financeira do destinatário.
        - `account` string: Número da conta do destinatário, com mascaramento aplicado.
        - `branch` string: Agência do destinatário.
        - `taxId` string: CPF ou CNPJ do destinatário, com mascaramento aplicado.
        - `name` string: Nome ou razão social do destinatário.
        - `accountType` string: Tipo da conta do destinatário.
        - `key` string: Chave Pix vinculada ao contato, quando aplicável.
        - `personType` string: Tipo de pessoa do destinatário.
      - `createdAt` string, date-time: Data e hora (date-time) de criação do contato
      - `updatedAt` string, date-time: Data e hora (date-time) de criação do contato

## Other responses

- `400`: Bad Request
- `401`: Access Denied
- `500`: Internal Server Error

---

[API](https://skmtc.dev/celcoin/apis/baas-v2.md) - [All operations](https://skmtc.dev/celcoin/apis/baas-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/celcoin/apis/baas-v2/revisions/98ec6869c1f2?raw)