v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Empresas

Retornar empresas do CV CRM

🔒 Autenticação necessária

Esta API utiliza autenticação via e-mail e token nos headers da requisição. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)

Esta API é responsável por retornar todas as empresas cadastradas no CV, podendo filtrar pelo cnpj e Id da Empresa.

get/empresas

Query parameters

offsetinteger

registro inicial (Padrão 0)

limitinteger

Example:30

quantidade de registros (Padrão 30, máximo 500)

idempresainteger

Identificador da empresa

Example:123456

cnpjstring

CNPJ da empresa

Example:26015677000197

Headers

emailstring required

Example:email@email.com

E-mail de autenticação

tokenstring required

Token de autenticação

Example:2ed820f89afa16cabb6f1585f9a85b4e6bfc80c3

Response

Empresas

Example response

{
  "empresas": [
    {
      "idempresa": 123,
      "matricula": 123,
      "nire": "123",
      "cnpj": "26015677000197",
      "nome": "Empresa Teste nome",
      "sigla": "EMPRESA SI",
      "razao_social": "RAzao Social Teste ",
      "data_cad": "2023-07-24 13:48:13",
      "codigo_interno": 12357,
      "telefone": 79999878877,
      "email": "teste@empresa.com",
      "ativo_painel": "S",
      "observacoes": "observacoes",
      "Endereco": {
        "nome": "Novo",
        "cep": "49080000",
        "numero": "1000",
        "bairro": "Novo paraiso",
        "complemento": "Colombia",
        "logradouro": {
          "idlogradouro": 2,
          "nome": "Rua"
        },
        "estado": {
          "idestado": 26,
          "nome": "Sergipe"
        },
        "cidade": {
          "idcidade": 5777,
          "nome": "Aracaju"
        }
      },
      "dados_bancarios": {
        "banco_agencia": "1234",
        "banco_conta": "12345678",
        "banco_chave_pix": "12345678900"
      },
      "dados_representante": {
        "representante_nome": "representante nome",
        "representante_cpf": "84443267204",
        "representante_email": "teste@email.com",
        "representante_telefone": "34417885",
        "representante_celular": "7999857455"
      }
    }
  ]
}