---
title: "Retornar lista de clientes"
method: GET
path: "/v1/parceiros/clientes"
tags: ["Clientes"]
---

# Retornar lista de clientes

`GET /v1/parceiros/clientes`

Permite acessar a lista de clientes cadastrados no ERP. A resposta da API contém apenas os clientes ativos ou inativos que já foram cadastrados previamente no ERP.

## Query parameters

- `page` integer, required
- `dataHoraAlteracao` string

## Response `200`

Operação bem sucedida. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.

- ClienteResponseList
  - `codigo` integer
  - `tipo` string
  - `mensagem` string
  - `page` integer
  - `numeroRegistros` integer
  - `temMaisRegistros` boolean
  - `clientes` ClienteResponse[]
    - `tipo` 'PF' | 'PJ' — Tipo da pessoa que pode ser Física ou Jurídica
    - `cnpjCpf` string — Documento CNPJ ou CPF, de acordo com o tipo do consumidor
    - `ieRg` string — Documento Inscrição Estadual ou RG, de acordo com o tipo do consumidor
    - `nome` string — Nome da pessoa física ou nome fantasia para pessoa juridica
    - `razao` string — Nome social para pessoa jurídica
    - `email` string
    - `telefoneDdd` string
    - `telefoneNumero` string
    - `limiteCredito` number
    - `grupoAutorizacao` string — Este campo garante que um tipo de negociação só possa ser usado por Clientes que fazem parte do mesmo grupo de autorização. Para mais detalhes [clique aqui](https://ajuda.sankhya.com.br/hc/pt-br/articles/7884939083671-Grupo-de-Autoriza%C3%A7%C3%A3o-Como-vincular-Tipo-de-Negocia%C3%A7%C3%A3o-ao-Parceiro) e saiba mais.
    - `endereco` EnderecoCliente
      - `logradouro` string, required
      - `numero` string, int64, required
      - `complemento` string
      - `bairro` string, required
      - `cidade` string, required
      - `codigoIbge` string, required
      - `uf` string, required
      - `cep` string, required
    - `camposAdicionais` CamposAdicionais — Os campos adicionais necessários precisam estar dentro desde objeto.
      - `AD_TESTE_API_CAMPO_ADICIONAL_1` string, required
      - `AD_TESTE_API_CAMPO_ADICIONAL_2` string, required
      - `AD_TESTE_API_CAMPO_ADICIONAL_3` string, required
      - `AD_TESTE_API_CAMPO_ADICIONAL_4` string, required
    - `codigoCliente` number

## Other responses

- `400` — Informações Inválidas. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `401` — Não autenticado. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `403` — Autenticação inválida. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `404` — Dados não encontrados. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `500` — Erro interno no servidor. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `501` — Não implementado. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `502` — Retorno inválido do servidor. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `503` — Serviço indisponível no momento. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `504` — Tempo de execução excedido. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.

---

[API](https://skmtc.net/sankhya/apis/api-sankhya.md) · [All operations](https://skmtc.net/sankhya/apis/api-sankhya/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sankhya/api-sankhya/versions/0a3e81ca6195/schema)