v1

latestOpenAPI 3.1.02026-07-249043961.2 KB

Clientes

Listar Clientes

Lista clientes.

get/v1/customers

Headers

User-Agentstring

Informar um e-mail válido para contatos.

Response

Sucesso na listagem de clientes

idinteger

external_codestring nullable

Código Externo

cnpj_cpfstring

CPF/CNPJ

person_namestring required

Nome ou Razão Social

contact_personstring nullable

Pessoa de Contato (quando Empresa)

nicknamestring nullable

Apelido ou Nome Fantasia do Pagador

birthdaystring date nullable

Data de Nascimento

emailstring email

E-mail principal

email_ccstring email

E-mail alternativo

addressstring required

Endereço

address_complementstring nullable

Complemento do Endereço

address_numberstring

Número

neighborhoodstring required

Bairro

zipcodestring required

CEP (formato 99999999)

statestring

Estado

city_namestring required

Cidade (Nome deve estar correto e completo)

phone_numberstring nullable

Telefone (com DDD, DDI é opcional)

mobile_local_codestring nullable

DDD do Celular

mobile_numberstring nullable

Celular

ignore_emailboolean nullable

Nunca enviar e-mail para este cliente

ignore_smsboolean nullable

Nunca enviar SMS para este cliente

ignore_whatsappboolean nullable

Nunca enviar Whatsapp para este cliente

notesstring nullable

Observações

tagsstring[] nullable

Tags associadas ao registro

tag_liststring nullable

Tags associadas ao registro

custom_dataobject nullable

Hash com chave e valor no formato JSON.

created_via_apiboolean nullable

Indica se o registro foi criado por API

created_atstring date-time nullable

Data e hora de criação do registro

updated_atstring date-time nullable

Data e hora da última atualização do registro

Example response

[
  {
    "external_code": "C0001",
    "cnpj_cpf": "16.974.923/0001-84",
    "person_name": "João Silva",
    "birthday": "1978-06-12",
    "email": "cliente@example.com",
    "email_cc": "outroemail@example.com",
    "address": "Rua F, alamenda G",
    "neighborhood": "Centro",
    "zipcode": "01310100",
    "state": "SP",
    "city_name": "São Paulo"
  }
]