v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Pessoas

Lista pessoas.

🔒 Autenticação necessária

Esta API utiliza Bearer Token no header Authorization. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)

Retorna uma lista paginada de pessoas cadastradas no sistema. É possível filtrar por idpessoa, nome, documento, telefone ou e-mail.

get/v3/cadastros/pessoas

Query parameters

idpessoainteger
Example:123

Identificador da pessoa.

nomestring
Example:Joselino

Nome da pessoa (busca parcial via LIKE).

documentostring
Example:64239558811

CPF ou CNPJ da pessoa (somente dígitos).

telefonestring
Example:79999999999

Telefone da pessoa.

emailstring
Example:joselino@email.com

E-mail da pessoa.

paginainteger
Example:1

Número da página.

registros_por_paginainteger
Example:20

Quantidade de registros por página.

Response

Lista de pessoas retornada com sucesso.

statusstring
codeinteger

Example response

{
  "status": "success",
  "code": 200,
  "data": {
    "dados": [
      {
        "idpessoa": 123,
        "idpessoaLegado": "5487",
        "codigointerno": "CLI-001",
        "ativoLogin": true,
        "nome": "Joselino Augusto dos Santos",
        "documento": "64239558811",
        "documentoTipo": "cpf",
        "rg": "35129640",
        "rgOrgaoEmissor": "SSP-SE",
        "rgDataEmissao": "2010-05-03 00:00:00",
        "dataNasc": "1990-06-15 00:00:00",
        "sexo": "M",
        "nacionalidade": "Brasileiro",
        "email": "joselino@email.com",
        "telefone": "+5579999999999",
        "celular": "+5579988888888",
        "cep": "49000000",
        "idpais": 33,
        "pais": "Brasil",
        "idestado": 26,
        "estado": "Sergipe",
        "idcidade": 4733,
        "cidade": "Aracaju",
        "idlogradouro": 9,
        "logradouro": "Rua",
        "endereco": "Av. Adel Nunes",
        "bairro": "Farolândia",
        "numero": "959",
        "complemento": "Bloco H",
        "naturalidade": "Aracajuano",
        "profissao": "Analista",
        "rendaFamiliar": 5000,
        "observacoes": "Cliente aguardando certidão de divórcio.",
        "estadoCivil": 4,
        "dataCasamento": "2018-08-11 00:00:00",
        "filiacaoPai": "Pedro dos Santos",
        "filiacaoMae": "Maria dos Santos",
        "inscEstadual": "123.987.283.874",
        "inscMunicipal": "657943-7",
        "dataPrimeiraHabilitacaoCnh": "2010-05-03 00:00:00",
        "dataFimValidadeCnh": "2030-05-03 00:00:00",
        "dataCad": "2021-04-19 13:48:13",
        "tags": [
          {
            "idtag": 1,
            "nome": "Bom pagador"
          }
        ],
        "idclassificacao": 3,
        "trabalhoNomeEmpresa": "Construtor de Vendas",
        "trabalhoCep": "01310100",
        "trabalhoIdestado": 26,
        "trabalhoEstado": "São Paulo",
        "trabalhoIdcidade": 4733,
        "trabalhoCidade": "São Paulo",
        "trabalhoEndereco": "Av. Paulista",
        "trabalhoBairro": "Bela Vista",
        "trabalhoNumero": "1000",
        "complementoTrabalho": "10° andar",
        "trabalhoTelefone": "1133334444",
        "idlogradouroTrabalho": 5,
        "logradouroTrabalho": "Avenida"
      }
    ],
    "total": 1,
    "pagina": 1,
    "registros_por_pagina": 20
  }
}
All 463 operations